| Index: third_party/gmock/include/gmock/gmock-spec-builders.h
|
| diff --git a/third_party/gmock/include/gmock/gmock-spec-builders.h b/third_party/gmock/include/gmock/gmock-spec-builders.h
|
| deleted file mode 100644
|
| index 9cb549abcb18c384f57aaa393677bbc24ecbccab..0000000000000000000000000000000000000000
|
| --- a/third_party/gmock/include/gmock/gmock-spec-builders.h
|
| +++ /dev/null
|
| @@ -1,1840 +0,0 @@
|
| -// 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.
|
| -//
|
| -// Author: wan@google.com (Zhanyong Wan)
|
| -
|
| -// Google Mock - a framework for writing C++ mock classes.
|
| -//
|
| -// This file implements the ON_CALL() and EXPECT_CALL() macros.
|
| -//
|
| -// A user can use the ON_CALL() macro to specify the default action of
|
| -// a mock method. The syntax is:
|
| -//
|
| -// ON_CALL(mock_object, Method(argument-matchers))
|
| -// .With(multi-argument-matcher)
|
| -// .WillByDefault(action);
|
| -//
|
| -// where the .With() clause is optional.
|
| -//
|
| -// A user can use the EXPECT_CALL() macro to specify an expectation on
|
| -// a mock method. The syntax is:
|
| -//
|
| -// EXPECT_CALL(mock_object, Method(argument-matchers))
|
| -// .With(multi-argument-matchers)
|
| -// .Times(cardinality)
|
| -// .InSequence(sequences)
|
| -// .After(expectations)
|
| -// .WillOnce(action)
|
| -// .WillRepeatedly(action)
|
| -// .RetiresOnSaturation();
|
| -//
|
| -// where all clauses are optional, and .InSequence()/.After()/
|
| -// .WillOnce() can appear any number of times.
|
| -
|
| -#ifndef GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_
|
| -#define GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_
|
| -
|
| -#include <map>
|
| -#include <set>
|
| -#include <sstream>
|
| -#include <string>
|
| -#include <vector>
|
| -
|
| -#include <gmock/gmock-actions.h>
|
| -#include <gmock/gmock-cardinalities.h>
|
| -#include <gmock/gmock-matchers.h>
|
| -#include <gmock/gmock-printers.h>
|
| -#include <gmock/internal/gmock-internal-utils.h>
|
| -#include <gmock/internal/gmock-port.h>
|
| -#include <gtest/gtest.h>
|
| -
|
| -namespace testing {
|
| -
|
| -// An abstract handle of an expectation.
|
| -class Expectation;
|
| -
|
| -// A set of expectation handles.
|
| -class ExpectationSet;
|
| -
|
| -// Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION
|
| -// and MUST NOT BE USED IN USER CODE!!!
|
| -namespace internal {
|
| -
|
| -// Implements a mock function.
|
| -template <typename F> class FunctionMocker;
|
| -
|
| -// Base class for expectations.
|
| -class ExpectationBase;
|
| -
|
| -// Implements an expectation.
|
| -template <typename F> class TypedExpectation;
|
| -
|
| -// Helper class for testing the Expectation class template.
|
| -class ExpectationTester;
|
| -
|
| -// Base class for function mockers.
|
| -template <typename F> class FunctionMockerBase;
|
| -
|
| -// Protects the mock object registry (in class Mock), all function
|
| -// mockers, and all expectations.
|
| -//
|
| -// The reason we don't use more fine-grained protection is: when a
|
| -// mock function Foo() is called, it needs to consult its expectations
|
| -// to see which one should be picked. If another thread is allowed to
|
| -// call a mock function (either Foo() or a different one) at the same
|
| -// time, it could affect the "retired" attributes of Foo()'s
|
| -// expectations when InSequence() is used, and thus affect which
|
| -// expectation gets picked. Therefore, we sequence all mock function
|
| -// calls to ensure the integrity of the mock objects' states.
|
| -extern Mutex g_gmock_mutex;
|
| -
|
| -// Abstract base class of FunctionMockerBase. This is the
|
| -// type-agnostic part of the function mocker interface. Its pure
|
| -// virtual methods are implemented by FunctionMockerBase.
|
| -class UntypedFunctionMockerBase {
|
| - public:
|
| - virtual ~UntypedFunctionMockerBase() {}
|
| -
|
| - // Verifies that all expectations on this mock function have been
|
| - // satisfied. Reports one or more Google Test non-fatal failures
|
| - // and returns false if not.
|
| - // L >= g_gmock_mutex
|
| - virtual bool VerifyAndClearExpectationsLocked() = 0;
|
| -
|
| - // Clears the ON_CALL()s set on this mock function.
|
| - // L >= g_gmock_mutex
|
| - virtual void ClearDefaultActionsLocked() = 0;
|
| -}; // class UntypedFunctionMockerBase
|
| -
|
| -// This template class implements a default action spec (i.e. an
|
| -// ON_CALL() statement).
|
| -template <typename F>
|
| -class DefaultActionSpec {
|
| - public:
|
| - typedef typename Function<F>::ArgumentTuple ArgumentTuple;
|
| - typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;
|
| -
|
| - // Constructs a DefaultActionSpec object from the information inside
|
| - // the parenthesis of an ON_CALL() statement.
|
| - DefaultActionSpec(const char* file, int line,
|
| - const ArgumentMatcherTuple& matchers)
|
| - : file_(file),
|
| - line_(line),
|
| - matchers_(matchers),
|
| - // By default, extra_matcher_ should match anything. However,
|
| - // we cannot initialize it with _ as that triggers a compiler
|
| - // bug in Symbian's C++ compiler (cannot decide between two
|
| - // overloaded constructors of Matcher<const ArgumentTuple&>).
|
| - extra_matcher_(A<const ArgumentTuple&>()),
|
| - last_clause_(kNone) {
|
| - }
|
| -
|
| - // Where in the source file was the default action spec defined?
|
| - const char* file() const { return file_; }
|
| - int line() const { return line_; }
|
| -
|
| - // Implements the .With() clause.
|
| - DefaultActionSpec& With(const Matcher<const ArgumentTuple&>& m) {
|
| - // Makes sure this is called at most once.
|
| - ExpectSpecProperty(last_clause_ < kWith,
|
| - ".With() cannot appear "
|
| - "more than once in an ON_CALL().");
|
| - last_clause_ = kWith;
|
| -
|
| - extra_matcher_ = m;
|
| - return *this;
|
| - }
|
| -
|
| - // Implements the .WillByDefault() clause.
|
| - DefaultActionSpec& WillByDefault(const Action<F>& action) {
|
| - ExpectSpecProperty(last_clause_ < kWillByDefault,
|
| - ".WillByDefault() must appear "
|
| - "exactly once in an ON_CALL().");
|
| - last_clause_ = kWillByDefault;
|
| -
|
| - ExpectSpecProperty(!action.IsDoDefault(),
|
| - "DoDefault() cannot be used in ON_CALL().");
|
| - action_ = action;
|
| - return *this;
|
| - }
|
| -
|
| - // Returns true iff the given arguments match the matchers.
|
| - bool Matches(const ArgumentTuple& args) const {
|
| - return TupleMatches(matchers_, args) && extra_matcher_.Matches(args);
|
| - }
|
| -
|
| - // Returns the action specified by the user.
|
| - const Action<F>& GetAction() const {
|
| - AssertSpecProperty(last_clause_ == kWillByDefault,
|
| - ".WillByDefault() must appear exactly "
|
| - "once in an ON_CALL().");
|
| - return action_;
|
| - }
|
| - private:
|
| - // Gives each clause in the ON_CALL() statement a name.
|
| - enum Clause {
|
| - // Do not change the order of the enum members! The run-time
|
| - // syntax checking relies on it.
|
| - kNone,
|
| - kWith,
|
| - kWillByDefault,
|
| - };
|
| -
|
| - // Asserts that the ON_CALL() statement has a certain property.
|
| - void AssertSpecProperty(bool property, const string& failure_message) const {
|
| - Assert(property, file_, line_, failure_message);
|
| - }
|
| -
|
| - // Expects that the ON_CALL() statement has a certain property.
|
| - void ExpectSpecProperty(bool property, const string& failure_message) const {
|
| - Expect(property, file_, line_, failure_message);
|
| - }
|
| -
|
| - // The information in statement
|
| - //
|
| - // ON_CALL(mock_object, Method(matchers))
|
| - // .With(multi-argument-matcher)
|
| - // .WillByDefault(action);
|
| - //
|
| - // is recorded in the data members like this:
|
| - //
|
| - // source file that contains the statement => file_
|
| - // line number of the statement => line_
|
| - // matchers => matchers_
|
| - // multi-argument-matcher => extra_matcher_
|
| - // action => action_
|
| - const char* file_;
|
| - int line_;
|
| - ArgumentMatcherTuple matchers_;
|
| - Matcher<const ArgumentTuple&> extra_matcher_;
|
| - Action<F> action_;
|
| -
|
| - // The last clause in the ON_CALL() statement as seen so far.
|
| - // Initially kNone and changes as the statement is parsed.
|
| - Clause last_clause_;
|
| -}; // class DefaultActionSpec
|
| -
|
| -// Possible reactions on uninteresting calls. TODO(wan@google.com):
|
| -// rename the enum values to the kFoo style.
|
| -enum CallReaction {
|
| - ALLOW,
|
| - WARN,
|
| - FAIL,
|
| -};
|
| -
|
| -} // namespace internal
|
| -
|
| -// Utilities for manipulating mock objects.
|
| -class Mock {
|
| - public:
|
| - // The following public methods can be called concurrently.
|
| -
|
| - // Tells Google Mock to ignore mock_obj when checking for leaked
|
| - // mock objects.
|
| - static void AllowLeak(const void* mock_obj);
|
| -
|
| - // Verifies and clears all expectations on the given mock object.
|
| - // If the expectations aren't satisfied, generates one or more
|
| - // Google Test non-fatal failures and returns false.
|
| - static bool VerifyAndClearExpectations(void* mock_obj);
|
| -
|
| - // Verifies all expectations on the given mock object and clears its
|
| - // default actions and expectations. Returns true iff the
|
| - // verification was successful.
|
| - static bool VerifyAndClear(void* mock_obj);
|
| - private:
|
| - // Needed for a function mocker to register itself (so that we know
|
| - // how to clear a mock object).
|
| - template <typename F>
|
| - friend class internal::FunctionMockerBase;
|
| -
|
| - template <typename M>
|
| - friend class NiceMock;
|
| -
|
| - template <typename M>
|
| - friend class StrictMock;
|
| -
|
| - // Tells Google Mock to allow uninteresting calls on the given mock
|
| - // object.
|
| - // L < g_gmock_mutex
|
| - static void AllowUninterestingCalls(const void* mock_obj);
|
| -
|
| - // Tells Google Mock to warn the user about uninteresting calls on
|
| - // the given mock object.
|
| - // L < g_gmock_mutex
|
| - static void WarnUninterestingCalls(const void* mock_obj);
|
| -
|
| - // Tells Google Mock to fail uninteresting calls on the given mock
|
| - // object.
|
| - // L < g_gmock_mutex
|
| - static void FailUninterestingCalls(const void* mock_obj);
|
| -
|
| - // Tells Google Mock the given mock object is being destroyed and
|
| - // its entry in the call-reaction table should be removed.
|
| - // L < g_gmock_mutex
|
| - static void UnregisterCallReaction(const void* mock_obj);
|
| -
|
| - // Returns the reaction Google Mock will have on uninteresting calls
|
| - // made on the given mock object.
|
| - // L < g_gmock_mutex
|
| - static internal::CallReaction GetReactionOnUninterestingCalls(
|
| - const void* mock_obj);
|
| -
|
| - // Verifies that all expectations on the given mock object have been
|
| - // satisfied. Reports one or more Google Test non-fatal failures
|
| - // and returns false if not.
|
| - // L >= g_gmock_mutex
|
| - static bool VerifyAndClearExpectationsLocked(void* mock_obj);
|
| -
|
| - // Clears all ON_CALL()s set on the given mock object.
|
| - // L >= g_gmock_mutex
|
| - static void ClearDefaultActionsLocked(void* mock_obj);
|
| -
|
| - // Registers a mock object and a mock method it owns.
|
| - // L < g_gmock_mutex
|
| - static void Register(const void* mock_obj,
|
| - internal::UntypedFunctionMockerBase* mocker);
|
| -
|
| - // Tells Google Mock where in the source code mock_obj is used in an
|
| - // ON_CALL or EXPECT_CALL. In case mock_obj is leaked, this
|
| - // information helps the user identify which object it is.
|
| - // L < g_gmock_mutex
|
| - static void RegisterUseByOnCallOrExpectCall(
|
| - const void* mock_obj, const char* file, int line);
|
| -
|
| - // Unregisters a mock method; removes the owning mock object from
|
| - // the registry when the last mock method associated with it has
|
| - // been unregistered. This is called only in the destructor of
|
| - // FunctionMockerBase.
|
| - // L >= g_gmock_mutex
|
| - static void UnregisterLocked(internal::UntypedFunctionMockerBase* mocker);
|
| -}; // class Mock
|
| -
|
| -// An abstract handle of an expectation. Useful in the .After()
|
| -// clause of EXPECT_CALL() for setting the (partial) order of
|
| -// expectations. The syntax:
|
| -//
|
| -// Expectation e1 = EXPECT_CALL(...)...;
|
| -// EXPECT_CALL(...).After(e1)...;
|
| -//
|
| -// sets two expectations where the latter can only be matched after
|
| -// the former has been satisfied.
|
| -//
|
| -// Notes:
|
| -// - This class is copyable and has value semantics.
|
| -// - Constness is shallow: a const Expectation object itself cannot
|
| -// be modified, but the mutable methods of the ExpectationBase
|
| -// object it references can be called via expectation_base().
|
| -// - The constructors and destructor are defined out-of-line because
|
| -// the Symbian WINSCW compiler wants to otherwise instantiate them
|
| -// when it sees this class definition, at which point it doesn't have
|
| -// ExpectationBase available yet, leading to incorrect destruction
|
| -// in the linked_ptr (or compilation errors if using a checking
|
| -// linked_ptr).
|
| -class Expectation {
|
| - public:
|
| - // Constructs a null object that doesn't reference any expectation.
|
| - Expectation();
|
| -
|
| - ~Expectation();
|
| -
|
| - // This single-argument ctor must not be explicit, in order to support the
|
| - // Expectation e = EXPECT_CALL(...);
|
| - // syntax.
|
| - //
|
| - // A TypedExpectation object stores its pre-requisites as
|
| - // Expectation objects, and needs to call the non-const Retire()
|
| - // method on the ExpectationBase objects they reference. Therefore
|
| - // Expectation must receive a *non-const* reference to the
|
| - // ExpectationBase object.
|
| - Expectation(internal::ExpectationBase& exp); // NOLINT
|
| -
|
| - // The compiler-generated copy ctor and operator= work exactly as
|
| - // intended, so we don't need to define our own.
|
| -
|
| - // Returns true iff rhs references the same expectation as this object does.
|
| - bool operator==(const Expectation& rhs) const {
|
| - return expectation_base_ == rhs.expectation_base_;
|
| - }
|
| -
|
| - bool operator!=(const Expectation& rhs) const { return !(*this == rhs); }
|
| -
|
| - private:
|
| - friend class ExpectationSet;
|
| - friend class Sequence;
|
| - friend class ::testing::internal::ExpectationBase;
|
| -
|
| - template <typename F>
|
| - friend class ::testing::internal::FunctionMockerBase;
|
| -
|
| - template <typename F>
|
| - friend class ::testing::internal::TypedExpectation;
|
| -
|
| - // This comparator is needed for putting Expectation objects into a set.
|
| - class Less {
|
| - public:
|
| - bool operator()(const Expectation& lhs, const Expectation& rhs) const {
|
| - return lhs.expectation_base_.get() < rhs.expectation_base_.get();
|
| - }
|
| - };
|
| -
|
| - typedef ::std::set<Expectation, Less> Set;
|
| -
|
| - Expectation(
|
| - const internal::linked_ptr<internal::ExpectationBase>& expectation_base);
|
| -
|
| - // Returns the expectation this object references.
|
| - const internal::linked_ptr<internal::ExpectationBase>&
|
| - expectation_base() const {
|
| - return expectation_base_;
|
| - }
|
| -
|
| - // A linked_ptr that co-owns the expectation this handle references.
|
| - internal::linked_ptr<internal::ExpectationBase> expectation_base_;
|
| -};
|
| -
|
| -// A set of expectation handles. Useful in the .After() clause of
|
| -// EXPECT_CALL() for setting the (partial) order of expectations. The
|
| -// syntax:
|
| -//
|
| -// ExpectationSet es;
|
| -// es += EXPECT_CALL(...)...;
|
| -// es += EXPECT_CALL(...)...;
|
| -// EXPECT_CALL(...).After(es)...;
|
| -//
|
| -// sets three expectations where the last one can only be matched
|
| -// after the first two have both been satisfied.
|
| -//
|
| -// This class is copyable and has value semantics.
|
| -class ExpectationSet {
|
| - public:
|
| - // A bidirectional iterator that can read a const element in the set.
|
| - typedef Expectation::Set::const_iterator const_iterator;
|
| -
|
| - // An object stored in the set. This is an alias of Expectation.
|
| - typedef Expectation::Set::value_type value_type;
|
| -
|
| - // Constructs an empty set.
|
| - ExpectationSet() {}
|
| -
|
| - // This single-argument ctor must not be explicit, in order to support the
|
| - // ExpectationSet es = EXPECT_CALL(...);
|
| - // syntax.
|
| - ExpectationSet(internal::ExpectationBase& exp) { // NOLINT
|
| - *this += Expectation(exp);
|
| - }
|
| -
|
| - // This single-argument ctor implements implicit conversion from
|
| - // Expectation and thus must not be explicit. This allows either an
|
| - // Expectation or an ExpectationSet to be used in .After().
|
| - ExpectationSet(const Expectation& e) { // NOLINT
|
| - *this += e;
|
| - }
|
| -
|
| - // The compiler-generator ctor and operator= works exactly as
|
| - // intended, so we don't need to define our own.
|
| -
|
| - // Returns true iff rhs contains the same set of Expectation objects
|
| - // as this does.
|
| - bool operator==(const ExpectationSet& rhs) const {
|
| - return expectations_ == rhs.expectations_;
|
| - }
|
| -
|
| - bool operator!=(const ExpectationSet& rhs) const { return !(*this == rhs); }
|
| -
|
| - // Implements the syntax
|
| - // expectation_set += EXPECT_CALL(...);
|
| - ExpectationSet& operator+=(const Expectation& e) {
|
| - expectations_.insert(e);
|
| - return *this;
|
| - }
|
| -
|
| - int size() const { return static_cast<int>(expectations_.size()); }
|
| -
|
| - const_iterator begin() const { return expectations_.begin(); }
|
| - const_iterator end() const { return expectations_.end(); }
|
| -
|
| - private:
|
| - Expectation::Set expectations_;
|
| -};
|
| -
|
| -
|
| -// Sequence objects are used by a user to specify the relative order
|
| -// in which the expectations should match. They are copyable (we rely
|
| -// on the compiler-defined copy constructor and assignment operator).
|
| -class Sequence {
|
| - public:
|
| - // Constructs an empty sequence.
|
| - Sequence() : last_expectation_(new Expectation) {}
|
| -
|
| - // Adds an expectation to this sequence. The caller must ensure
|
| - // that no other thread is accessing this Sequence object.
|
| - void AddExpectation(const Expectation& expectation) const;
|
| -
|
| - private:
|
| - // The last expectation in this sequence. We use a linked_ptr here
|
| - // because Sequence objects are copyable and we want the copies to
|
| - // be aliases. The linked_ptr allows the copies to co-own and share
|
| - // the same Expectation object.
|
| - internal::linked_ptr<Expectation> last_expectation_;
|
| -}; // class Sequence
|
| -
|
| -// An object of this type causes all EXPECT_CALL() statements
|
| -// encountered in its scope to be put in an anonymous sequence. The
|
| -// work is done in the constructor and destructor. You should only
|
| -// create an InSequence object on the stack.
|
| -//
|
| -// The sole purpose for this class is to support easy definition of
|
| -// sequential expectations, e.g.
|
| -//
|
| -// {
|
| -// InSequence dummy; // The name of the object doesn't matter.
|
| -//
|
| -// // The following expectations must match in the order they appear.
|
| -// EXPECT_CALL(a, Bar())...;
|
| -// EXPECT_CALL(a, Baz())...;
|
| -// ...
|
| -// EXPECT_CALL(b, Xyz())...;
|
| -// }
|
| -//
|
| -// You can create InSequence objects in multiple threads, as long as
|
| -// they are used to affect different mock objects. The idea is that
|
| -// each thread can create and set up its own mocks as if it's the only
|
| -// thread. However, for clarity of your tests we recommend you to set
|
| -// up mocks in the main thread unless you have a good reason not to do
|
| -// so.
|
| -class InSequence {
|
| - public:
|
| - InSequence();
|
| - ~InSequence();
|
| - private:
|
| - bool sequence_created_;
|
| -
|
| - GTEST_DISALLOW_COPY_AND_ASSIGN_(InSequence); // NOLINT
|
| -} GMOCK_ATTRIBUTE_UNUSED_;
|
| -
|
| -namespace internal {
|
| -
|
| -// Points to the implicit sequence introduced by a living InSequence
|
| -// object (if any) in the current thread or NULL.
|
| -extern ThreadLocal<Sequence*> g_gmock_implicit_sequence;
|
| -
|
| -// Base class for implementing expectations.
|
| -//
|
| -// There are two reasons for having a type-agnostic base class for
|
| -// Expectation:
|
| -//
|
| -// 1. We need to store collections of expectations of different
|
| -// types (e.g. all pre-requisites of a particular expectation, all
|
| -// expectations in a sequence). Therefore these expectation objects
|
| -// must share a common base class.
|
| -//
|
| -// 2. We can avoid binary code bloat by moving methods not depending
|
| -// on the template argument of Expectation to the base class.
|
| -//
|
| -// This class is internal and mustn't be used by user code directly.
|
| -class ExpectationBase {
|
| - public:
|
| - // source_text is the EXPECT_CALL(...) source that created this Expectation.
|
| - ExpectationBase(const char* file, int line, const string& source_text);
|
| -
|
| - virtual ~ExpectationBase();
|
| -
|
| - // Where in the source file was the expectation spec defined?
|
| - const char* file() const { return file_; }
|
| - int line() const { return line_; }
|
| - const char* source_text() const { return source_text_.c_str(); }
|
| - // Returns the cardinality specified in the expectation spec.
|
| - const Cardinality& cardinality() const { return cardinality_; }
|
| -
|
| - // Describes the source file location of this expectation.
|
| - void DescribeLocationTo(::std::ostream* os) const {
|
| - *os << file() << ":" << line() << ": ";
|
| - }
|
| -
|
| - // Describes how many times a function call matching this
|
| - // expectation has occurred.
|
| - // L >= g_gmock_mutex
|
| - virtual void DescribeCallCountTo(::std::ostream* os) const = 0;
|
| - protected:
|
| - friend class ::testing::Expectation;
|
| -
|
| - enum Clause {
|
| - // Don't change the order of the enum members!
|
| - kNone,
|
| - kWith,
|
| - kTimes,
|
| - kInSequence,
|
| - kAfter,
|
| - kWillOnce,
|
| - kWillRepeatedly,
|
| - kRetiresOnSaturation,
|
| - };
|
| -
|
| - // Returns an Expectation object that references and co-owns this
|
| - // expectation.
|
| - virtual Expectation GetHandle() = 0;
|
| -
|
| - // Asserts that the EXPECT_CALL() statement has the given property.
|
| - void AssertSpecProperty(bool property, const string& failure_message) const {
|
| - Assert(property, file_, line_, failure_message);
|
| - }
|
| -
|
| - // Expects that the EXPECT_CALL() statement has the given property.
|
| - void ExpectSpecProperty(bool property, const string& failure_message) const {
|
| - Expect(property, file_, line_, failure_message);
|
| - }
|
| -
|
| - // Explicitly specifies the cardinality of this expectation. Used
|
| - // by the subclasses to implement the .Times() clause.
|
| - void SpecifyCardinality(const Cardinality& cardinality);
|
| -
|
| - // Returns true iff the user specified the cardinality explicitly
|
| - // using a .Times().
|
| - bool cardinality_specified() const { return cardinality_specified_; }
|
| -
|
| - // Sets the cardinality of this expectation spec.
|
| - void set_cardinality(const Cardinality& cardinality) {
|
| - cardinality_ = cardinality;
|
| - }
|
| -
|
| - // The following group of methods should only be called after the
|
| - // EXPECT_CALL() statement, and only when g_gmock_mutex is held by
|
| - // the current thread.
|
| -
|
| - // Retires all pre-requisites of this expectation.
|
| - // L >= g_gmock_mutex
|
| - void RetireAllPreRequisites();
|
| -
|
| - // Returns true iff this expectation is retired.
|
| - // L >= g_gmock_mutex
|
| - bool is_retired() const {
|
| - g_gmock_mutex.AssertHeld();
|
| - return retired_;
|
| - }
|
| -
|
| - // Retires this expectation.
|
| - // L >= g_gmock_mutex
|
| - void Retire() {
|
| - g_gmock_mutex.AssertHeld();
|
| - retired_ = true;
|
| - }
|
| -
|
| - // Returns true iff this expectation is satisfied.
|
| - // L >= g_gmock_mutex
|
| - bool IsSatisfied() const {
|
| - g_gmock_mutex.AssertHeld();
|
| - return cardinality().IsSatisfiedByCallCount(call_count_);
|
| - }
|
| -
|
| - // Returns true iff this expectation is saturated.
|
| - // L >= g_gmock_mutex
|
| - bool IsSaturated() const {
|
| - g_gmock_mutex.AssertHeld();
|
| - return cardinality().IsSaturatedByCallCount(call_count_);
|
| - }
|
| -
|
| - // Returns true iff this expectation is over-saturated.
|
| - // L >= g_gmock_mutex
|
| - bool IsOverSaturated() const {
|
| - g_gmock_mutex.AssertHeld();
|
| - return cardinality().IsOverSaturatedByCallCount(call_count_);
|
| - }
|
| -
|
| - // Returns true iff all pre-requisites of this expectation are satisfied.
|
| - // L >= g_gmock_mutex
|
| - bool AllPrerequisitesAreSatisfied() const;
|
| -
|
| - // Adds unsatisfied pre-requisites of this expectation to 'result'.
|
| - // L >= g_gmock_mutex
|
| - void FindUnsatisfiedPrerequisites(ExpectationSet* result) const;
|
| -
|
| - // Returns the number this expectation has been invoked.
|
| - // L >= g_gmock_mutex
|
| - int call_count() const {
|
| - g_gmock_mutex.AssertHeld();
|
| - return call_count_;
|
| - }
|
| -
|
| - // Increments the number this expectation has been invoked.
|
| - // L >= g_gmock_mutex
|
| - void IncrementCallCount() {
|
| - g_gmock_mutex.AssertHeld();
|
| - call_count_++;
|
| - }
|
| -
|
| - private:
|
| - friend class ::testing::Sequence;
|
| - friend class ::testing::internal::ExpectationTester;
|
| -
|
| - template <typename Function>
|
| - friend class TypedExpectation;
|
| -
|
| - // This group of fields are part of the spec and won't change after
|
| - // an EXPECT_CALL() statement finishes.
|
| - const char* file_; // The file that contains the expectation.
|
| - int line_; // The line number of the expectation.
|
| - const string source_text_; // The EXPECT_CALL(...) source text.
|
| - // True iff the cardinality is specified explicitly.
|
| - bool cardinality_specified_;
|
| - Cardinality cardinality_; // The cardinality of the expectation.
|
| - // The immediate pre-requisites (i.e. expectations that must be
|
| - // satisfied before this expectation can be matched) of this
|
| - // expectation. We use linked_ptr in the set because we want an
|
| - // Expectation object to be co-owned by its FunctionMocker and its
|
| - // successors. This allows multiple mock objects to be deleted at
|
| - // different times.
|
| - ExpectationSet immediate_prerequisites_;
|
| -
|
| - // This group of fields are the current state of the expectation,
|
| - // and can change as the mock function is called.
|
| - int call_count_; // How many times this expectation has been invoked.
|
| - bool retired_; // True iff this expectation has retired.
|
| -}; // class ExpectationBase
|
| -
|
| -// Impements an expectation for the given function type.
|
| -template <typename F>
|
| -class TypedExpectation : public ExpectationBase {
|
| - public:
|
| - typedef typename Function<F>::ArgumentTuple ArgumentTuple;
|
| - typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;
|
| - typedef typename Function<F>::Result Result;
|
| -
|
| - TypedExpectation(FunctionMockerBase<F>* owner,
|
| - const char* file, int line, const string& source_text,
|
| - const ArgumentMatcherTuple& m)
|
| - : ExpectationBase(file, line, source_text),
|
| - owner_(owner),
|
| - matchers_(m),
|
| - extra_matcher_specified_(false),
|
| - // By default, extra_matcher_ should match anything. However,
|
| - // we cannot initialize it with _ as that triggers a compiler
|
| - // bug in Symbian's C++ compiler (cannot decide between two
|
| - // overloaded constructors of Matcher<const ArgumentTuple&>).
|
| - extra_matcher_(A<const ArgumentTuple&>()),
|
| - repeated_action_specified_(false),
|
| - repeated_action_(DoDefault()),
|
| - retires_on_saturation_(false),
|
| - last_clause_(kNone),
|
| - action_count_checked_(false) {}
|
| -
|
| - virtual ~TypedExpectation() {
|
| - // Check the validity of the action count if it hasn't been done
|
| - // yet (for example, if the expectation was never used).
|
| - CheckActionCountIfNotDone();
|
| - }
|
| -
|
| - // Implements the .With() clause.
|
| - TypedExpectation& With(const Matcher<const ArgumentTuple&>& m) {
|
| - if (last_clause_ == kWith) {
|
| - ExpectSpecProperty(false,
|
| - ".With() cannot appear "
|
| - "more than once in an EXPECT_CALL().");
|
| - } else {
|
| - ExpectSpecProperty(last_clause_ < kWith,
|
| - ".With() must be the first "
|
| - "clause in an EXPECT_CALL().");
|
| - }
|
| - last_clause_ = kWith;
|
| -
|
| - extra_matcher_ = m;
|
| - extra_matcher_specified_ = true;
|
| - return *this;
|
| - }
|
| -
|
| - // Implements the .Times() clause.
|
| - TypedExpectation& Times(const Cardinality& cardinality) {
|
| - if (last_clause_ ==kTimes) {
|
| - ExpectSpecProperty(false,
|
| - ".Times() cannot appear "
|
| - "more than once in an EXPECT_CALL().");
|
| - } else {
|
| - ExpectSpecProperty(last_clause_ < kTimes,
|
| - ".Times() cannot appear after "
|
| - ".InSequence(), .WillOnce(), .WillRepeatedly(), "
|
| - "or .RetiresOnSaturation().");
|
| - }
|
| - last_clause_ = kTimes;
|
| -
|
| - ExpectationBase::SpecifyCardinality(cardinality);
|
| - return *this;
|
| - }
|
| -
|
| - // Implements the .Times() clause.
|
| - TypedExpectation& Times(int n) {
|
| - return Times(Exactly(n));
|
| - }
|
| -
|
| - // Implements the .InSequence() clause.
|
| - TypedExpectation& InSequence(const Sequence& s) {
|
| - ExpectSpecProperty(last_clause_ <= kInSequence,
|
| - ".InSequence() cannot appear after .After(),"
|
| - " .WillOnce(), .WillRepeatedly(), or "
|
| - ".RetiresOnSaturation().");
|
| - last_clause_ = kInSequence;
|
| -
|
| - s.AddExpectation(GetHandle());
|
| - return *this;
|
| - }
|
| - TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2) {
|
| - return InSequence(s1).InSequence(s2);
|
| - }
|
| - TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
|
| - const Sequence& s3) {
|
| - return InSequence(s1, s2).InSequence(s3);
|
| - }
|
| - TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
|
| - const Sequence& s3, const Sequence& s4) {
|
| - return InSequence(s1, s2, s3).InSequence(s4);
|
| - }
|
| - TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
|
| - const Sequence& s3, const Sequence& s4,
|
| - const Sequence& s5) {
|
| - return InSequence(s1, s2, s3, s4).InSequence(s5);
|
| - }
|
| -
|
| - // Implements that .After() clause.
|
| - TypedExpectation& After(const ExpectationSet& s) {
|
| - ExpectSpecProperty(last_clause_ <= kAfter,
|
| - ".After() cannot appear after .WillOnce(),"
|
| - " .WillRepeatedly(), or "
|
| - ".RetiresOnSaturation().");
|
| - last_clause_ = kAfter;
|
| -
|
| - for (ExpectationSet::const_iterator it = s.begin(); it != s.end(); ++it) {
|
| - immediate_prerequisites_ += *it;
|
| - }
|
| - return *this;
|
| - }
|
| - TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2) {
|
| - return After(s1).After(s2);
|
| - }
|
| - TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
|
| - const ExpectationSet& s3) {
|
| - return After(s1, s2).After(s3);
|
| - }
|
| - TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
|
| - const ExpectationSet& s3, const ExpectationSet& s4) {
|
| - return After(s1, s2, s3).After(s4);
|
| - }
|
| - TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
|
| - const ExpectationSet& s3, const ExpectationSet& s4,
|
| - const ExpectationSet& s5) {
|
| - return After(s1, s2, s3, s4).After(s5);
|
| - }
|
| -
|
| - // Implements the .WillOnce() clause.
|
| - TypedExpectation& WillOnce(const Action<F>& action) {
|
| - ExpectSpecProperty(last_clause_ <= kWillOnce,
|
| - ".WillOnce() cannot appear after "
|
| - ".WillRepeatedly() or .RetiresOnSaturation().");
|
| - last_clause_ = kWillOnce;
|
| -
|
| - actions_.push_back(action);
|
| - if (!cardinality_specified()) {
|
| - set_cardinality(Exactly(static_cast<int>(actions_.size())));
|
| - }
|
| - return *this;
|
| - }
|
| -
|
| - // Implements the .WillRepeatedly() clause.
|
| - TypedExpectation& WillRepeatedly(const Action<F>& action) {
|
| - if (last_clause_ == kWillRepeatedly) {
|
| - ExpectSpecProperty(false,
|
| - ".WillRepeatedly() cannot appear "
|
| - "more than once in an EXPECT_CALL().");
|
| - } else {
|
| - ExpectSpecProperty(last_clause_ < kWillRepeatedly,
|
| - ".WillRepeatedly() cannot appear "
|
| - "after .RetiresOnSaturation().");
|
| - }
|
| - last_clause_ = kWillRepeatedly;
|
| - repeated_action_specified_ = true;
|
| -
|
| - repeated_action_ = action;
|
| - if (!cardinality_specified()) {
|
| - set_cardinality(AtLeast(static_cast<int>(actions_.size())));
|
| - }
|
| -
|
| - // Now that no more action clauses can be specified, we check
|
| - // whether their count makes sense.
|
| - CheckActionCountIfNotDone();
|
| - return *this;
|
| - }
|
| -
|
| - // Implements the .RetiresOnSaturation() clause.
|
| - TypedExpectation& RetiresOnSaturation() {
|
| - ExpectSpecProperty(last_clause_ < kRetiresOnSaturation,
|
| - ".RetiresOnSaturation() cannot appear "
|
| - "more than once.");
|
| - last_clause_ = kRetiresOnSaturation;
|
| - retires_on_saturation_ = true;
|
| -
|
| - // Now that no more action clauses can be specified, we check
|
| - // whether their count makes sense.
|
| - CheckActionCountIfNotDone();
|
| - return *this;
|
| - }
|
| -
|
| - // Returns the matchers for the arguments as specified inside the
|
| - // EXPECT_CALL() macro.
|
| - const ArgumentMatcherTuple& matchers() const {
|
| - return matchers_;
|
| - }
|
| -
|
| - // Returns the matcher specified by the .With() clause.
|
| - const Matcher<const ArgumentTuple&>& extra_matcher() const {
|
| - return extra_matcher_;
|
| - }
|
| -
|
| - // Returns the sequence of actions specified by the .WillOnce() clause.
|
| - const std::vector<Action<F> >& actions() const { return actions_; }
|
| -
|
| - // Returns the action specified by the .WillRepeatedly() clause.
|
| - const Action<F>& repeated_action() const { return repeated_action_; }
|
| -
|
| - // Returns true iff the .RetiresOnSaturation() clause was specified.
|
| - bool retires_on_saturation() const { return retires_on_saturation_; }
|
| -
|
| - // Describes how many times a function call matching this
|
| - // expectation has occurred (implements
|
| - // ExpectationBase::DescribeCallCountTo()).
|
| - // L >= g_gmock_mutex
|
| - virtual void DescribeCallCountTo(::std::ostream* os) const {
|
| - g_gmock_mutex.AssertHeld();
|
| -
|
| - // Describes how many times the function is expected to be called.
|
| - *os << " Expected: to be ";
|
| - cardinality().DescribeTo(os);
|
| - *os << "\n Actual: ";
|
| - Cardinality::DescribeActualCallCountTo(call_count(), os);
|
| -
|
| - // Describes the state of the expectation (e.g. is it satisfied?
|
| - // is it active?).
|
| - *os << " - " << (IsOverSaturated() ? "over-saturated" :
|
| - IsSaturated() ? "saturated" :
|
| - IsSatisfied() ? "satisfied" : "unsatisfied")
|
| - << " and "
|
| - << (is_retired() ? "retired" : "active");
|
| - }
|
| -
|
| - void MaybeDescribeExtraMatcherTo(::std::ostream* os) {
|
| - if (extra_matcher_specified_) {
|
| - *os << " Expected args: ";
|
| - extra_matcher_.DescribeTo(os);
|
| - *os << "\n";
|
| - }
|
| - }
|
| -
|
| - private:
|
| - template <typename Function>
|
| - friend class FunctionMockerBase;
|
| -
|
| - // Returns an Expectation object that references and co-owns this
|
| - // expectation.
|
| - virtual Expectation GetHandle() {
|
| - return owner_->GetHandleOf(this);
|
| - }
|
| -
|
| - // The following methods will be called only after the EXPECT_CALL()
|
| - // statement finishes and when the current thread holds
|
| - // g_gmock_mutex.
|
| -
|
| - // Returns true iff this expectation matches the given arguments.
|
| - // L >= g_gmock_mutex
|
| - bool Matches(const ArgumentTuple& args) const {
|
| - g_gmock_mutex.AssertHeld();
|
| - return TupleMatches(matchers_, args) && extra_matcher_.Matches(args);
|
| - }
|
| -
|
| - // Returns true iff this expectation should handle the given arguments.
|
| - // L >= g_gmock_mutex
|
| - bool ShouldHandleArguments(const ArgumentTuple& args) const {
|
| - g_gmock_mutex.AssertHeld();
|
| -
|
| - // In case the action count wasn't checked when the expectation
|
| - // was defined (e.g. if this expectation has no WillRepeatedly()
|
| - // or RetiresOnSaturation() clause), we check it when the
|
| - // expectation is used for the first time.
|
| - CheckActionCountIfNotDone();
|
| - return !is_retired() && AllPrerequisitesAreSatisfied() && Matches(args);
|
| - }
|
| -
|
| - // Describes the result of matching the arguments against this
|
| - // expectation to the given ostream.
|
| - // L >= g_gmock_mutex
|
| - void DescribeMatchResultTo(const ArgumentTuple& args,
|
| - ::std::ostream* os) const {
|
| - g_gmock_mutex.AssertHeld();
|
| -
|
| - if (is_retired()) {
|
| - *os << " Expected: the expectation is active\n"
|
| - << " Actual: it is retired\n";
|
| - } else if (!Matches(args)) {
|
| - if (!TupleMatches(matchers_, args)) {
|
| - DescribeMatchFailureTupleTo(matchers_, args, os);
|
| - }
|
| - if (!extra_matcher_.Matches(args)) {
|
| - *os << " Expected args: ";
|
| - extra_matcher_.DescribeTo(os);
|
| - *os << "\n Actual: don't match";
|
| -
|
| - internal::ExplainMatchResultAsNeededTo<const ArgumentTuple&>(
|
| - extra_matcher_, args, os);
|
| - *os << "\n";
|
| - }
|
| - } else if (!AllPrerequisitesAreSatisfied()) {
|
| - *os << " Expected: all pre-requisites are satisfied\n"
|
| - << " Actual: the following immediate pre-requisites "
|
| - << "are not satisfied:\n";
|
| - ExpectationSet unsatisfied_prereqs;
|
| - FindUnsatisfiedPrerequisites(&unsatisfied_prereqs);
|
| - int i = 0;
|
| - for (ExpectationSet::const_iterator it = unsatisfied_prereqs.begin();
|
| - it != unsatisfied_prereqs.end(); ++it) {
|
| - it->expectation_base()->DescribeLocationTo(os);
|
| - *os << "pre-requisite #" << i++ << "\n";
|
| - }
|
| - *os << " (end of pre-requisites)\n";
|
| - } else {
|
| - // This line is here just for completeness' sake. It will never
|
| - // be executed as currently the DescribeMatchResultTo() function
|
| - // is called only when the mock function call does NOT match the
|
| - // expectation.
|
| - *os << "The call matches the expectation.\n";
|
| - }
|
| - }
|
| -
|
| - // Returns the action that should be taken for the current invocation.
|
| - // L >= g_gmock_mutex
|
| - const Action<F>& GetCurrentAction(const FunctionMockerBase<F>* mocker,
|
| - const ArgumentTuple& args) const {
|
| - g_gmock_mutex.AssertHeld();
|
| - const int count = call_count();
|
| - Assert(count >= 1, __FILE__, __LINE__,
|
| - "call_count() is <= 0 when GetCurrentAction() is "
|
| - "called - this should never happen.");
|
| -
|
| - const int action_count = static_cast<int>(actions().size());
|
| - if (action_count > 0 && !repeated_action_specified_ &&
|
| - count > action_count) {
|
| - // If there is at least one WillOnce() and no WillRepeatedly(),
|
| - // we warn the user when the WillOnce() clauses ran out.
|
| - ::std::stringstream ss;
|
| - DescribeLocationTo(&ss);
|
| - ss << "Actions ran out in " << source_text() << "...\n"
|
| - << "Called " << count << " times, but only "
|
| - << action_count << " WillOnce()"
|
| - << (action_count == 1 ? " is" : "s are") << " specified - ";
|
| - mocker->DescribeDefaultActionTo(args, &ss);
|
| - Log(WARNING, ss.str(), 1);
|
| - }
|
| -
|
| - return count <= action_count ? actions()[count - 1] : repeated_action();
|
| - }
|
| -
|
| - // Given the arguments of a mock function call, if the call will
|
| - // over-saturate this expectation, returns the default action;
|
| - // otherwise, returns the next action in this expectation. Also
|
| - // describes *what* happened to 'what', and explains *why* Google
|
| - // Mock does it to 'why'. This method is not const as it calls
|
| - // IncrementCallCount().
|
| - // L >= g_gmock_mutex
|
| - Action<F> GetActionForArguments(const FunctionMockerBase<F>* mocker,
|
| - const ArgumentTuple& args,
|
| - ::std::ostream* what,
|
| - ::std::ostream* why) {
|
| - g_gmock_mutex.AssertHeld();
|
| - if (IsSaturated()) {
|
| - // We have an excessive call.
|
| - IncrementCallCount();
|
| - *what << "Mock function called more times than expected - ";
|
| - mocker->DescribeDefaultActionTo(args, what);
|
| - DescribeCallCountTo(why);
|
| -
|
| - // TODO(wan): allow the user to control whether unexpected calls
|
| - // should fail immediately or continue using a flag
|
| - // --gmock_unexpected_calls_are_fatal.
|
| - return DoDefault();
|
| - }
|
| -
|
| - IncrementCallCount();
|
| - RetireAllPreRequisites();
|
| -
|
| - if (retires_on_saturation() && IsSaturated()) {
|
| - Retire();
|
| - }
|
| -
|
| - // Must be done after IncrementCount()!
|
| - *what << "Mock function call matches " << source_text() <<"...\n";
|
| - return GetCurrentAction(mocker, args);
|
| - }
|
| -
|
| - // Checks the action count (i.e. the number of WillOnce() and
|
| - // WillRepeatedly() clauses) against the cardinality if this hasn't
|
| - // been done before. Prints a warning if there are too many or too
|
| - // few actions.
|
| - // L < mutex_
|
| - void CheckActionCountIfNotDone() const {
|
| - bool should_check = false;
|
| - {
|
| - MutexLock l(&mutex_);
|
| - if (!action_count_checked_) {
|
| - action_count_checked_ = true;
|
| - should_check = true;
|
| - }
|
| - }
|
| -
|
| - if (should_check) {
|
| - if (!cardinality_specified_) {
|
| - // The cardinality was inferred - no need to check the action
|
| - // count against it.
|
| - return;
|
| - }
|
| -
|
| - // The cardinality was explicitly specified.
|
| - const int action_count = static_cast<int>(actions_.size());
|
| - const int upper_bound = cardinality().ConservativeUpperBound();
|
| - const int lower_bound = cardinality().ConservativeLowerBound();
|
| - bool too_many; // True if there are too many actions, or false
|
| - // if there are too few.
|
| - if (action_count > upper_bound ||
|
| - (action_count == upper_bound && repeated_action_specified_)) {
|
| - too_many = true;
|
| - } else if (0 < action_count && action_count < lower_bound &&
|
| - !repeated_action_specified_) {
|
| - too_many = false;
|
| - } else {
|
| - return;
|
| - }
|
| -
|
| - ::std::stringstream ss;
|
| - DescribeLocationTo(&ss);
|
| - ss << "Too " << (too_many ? "many" : "few")
|
| - << " actions specified in " << source_text() << "...\n"
|
| - << "Expected to be ";
|
| - cardinality().DescribeTo(&ss);
|
| - ss << ", but has " << (too_many ? "" : "only ")
|
| - << action_count << " WillOnce()"
|
| - << (action_count == 1 ? "" : "s");
|
| - if (repeated_action_specified_) {
|
| - ss << " and a WillRepeatedly()";
|
| - }
|
| - ss << ".";
|
| - Log(WARNING, ss.str(), -1); // -1 means "don't print stack trace".
|
| - }
|
| - }
|
| -
|
| - // All the fields below won't change once the EXPECT_CALL()
|
| - // statement finishes.
|
| - FunctionMockerBase<F>* const owner_;
|
| - ArgumentMatcherTuple matchers_;
|
| - bool extra_matcher_specified_;
|
| - Matcher<const ArgumentTuple&> extra_matcher_;
|
| - std::vector<Action<F> > actions_;
|
| - bool repeated_action_specified_; // True if a WillRepeatedly() was specified.
|
| - Action<F> repeated_action_;
|
| - bool retires_on_saturation_;
|
| - Clause last_clause_;
|
| - mutable bool action_count_checked_; // Under mutex_.
|
| - mutable Mutex mutex_; // Protects action_count_checked_.
|
| -}; // class TypedExpectation
|
| -
|
| -// A MockSpec object is used by ON_CALL() or EXPECT_CALL() for
|
| -// specifying the default behavior of, or expectation on, a mock
|
| -// function.
|
| -
|
| -// Note: class MockSpec really belongs to the ::testing namespace.
|
| -// However if we define it in ::testing, MSVC will complain when
|
| -// classes in ::testing::internal declare it as a friend class
|
| -// template. To workaround this compiler bug, we define MockSpec in
|
| -// ::testing::internal and import it into ::testing.
|
| -
|
| -template <typename F>
|
| -class MockSpec {
|
| - public:
|
| - typedef typename internal::Function<F>::ArgumentTuple ArgumentTuple;
|
| - typedef typename internal::Function<F>::ArgumentMatcherTuple
|
| - ArgumentMatcherTuple;
|
| -
|
| - // Constructs a MockSpec object, given the function mocker object
|
| - // that the spec is associated with.
|
| - explicit MockSpec(internal::FunctionMockerBase<F>* function_mocker)
|
| - : function_mocker_(function_mocker) {}
|
| -
|
| - // Adds a new default action spec to the function mocker and returns
|
| - // the newly created spec.
|
| - internal::DefaultActionSpec<F>& InternalDefaultActionSetAt(
|
| - const char* file, int line, const char* obj, const char* call) {
|
| - LogWithLocation(internal::INFO, file, line,
|
| - string("ON_CALL(") + obj + ", " + call + ") invoked");
|
| - return function_mocker_->AddNewDefaultActionSpec(file, line, matchers_);
|
| - }
|
| -
|
| - // Adds a new expectation spec to the function mocker and returns
|
| - // the newly created spec.
|
| - internal::TypedExpectation<F>& InternalExpectedAt(
|
| - const char* file, int line, const char* obj, const char* call) {
|
| - const string source_text(string("EXPECT_CALL(") + obj + ", " + call + ")");
|
| - LogWithLocation(internal::INFO, file, line, source_text + " invoked");
|
| - return function_mocker_->AddNewExpectation(
|
| - file, line, source_text, matchers_);
|
| - }
|
| -
|
| - private:
|
| - template <typename Function>
|
| - friend class internal::FunctionMocker;
|
| -
|
| - void SetMatchers(const ArgumentMatcherTuple& matchers) {
|
| - matchers_ = matchers;
|
| - }
|
| -
|
| - // Logs a message including file and line number information.
|
| - void LogWithLocation(testing::internal::LogSeverity severity,
|
| - const char* file, int line,
|
| - const string& message) {
|
| - ::std::ostringstream s;
|
| - s << file << ":" << line << ": " << message << ::std::endl;
|
| - Log(severity, s.str(), 0);
|
| - }
|
| -
|
| - // The function mocker that owns this spec.
|
| - internal::FunctionMockerBase<F>* const function_mocker_;
|
| - // The argument matchers specified in the spec.
|
| - ArgumentMatcherTuple matchers_;
|
| -}; // class MockSpec
|
| -
|
| -// MSVC warns about using 'this' in base member initializer list, so
|
| -// we need to temporarily disable the warning. We have to do it for
|
| -// the entire class to suppress the warning, even though it's about
|
| -// the constructor only.
|
| -
|
| -#ifdef _MSC_VER
|
| -#pragma warning(push) // Saves the current warning state.
|
| -#pragma warning(disable:4355) // Temporarily disables warning 4355.
|
| -#endif // _MSV_VER
|
| -
|
| -// C++ treats the void type specially. For example, you cannot define
|
| -// a void-typed variable or pass a void value to a function.
|
| -// ActionResultHolder<T> holds a value of type T, where T must be a
|
| -// copyable type or void (T doesn't need to be default-constructable).
|
| -// It hides the syntactic difference between void and other types, and
|
| -// is used to unify the code for invoking both void-returning and
|
| -// non-void-returning mock functions. This generic definition is used
|
| -// when T is not void.
|
| -template <typename T>
|
| -class ActionResultHolder {
|
| - public:
|
| - explicit ActionResultHolder(T value) : value_(value) {}
|
| -
|
| - // The compiler-generated copy constructor and assignment operator
|
| - // are exactly what we need, so we don't need to define them.
|
| -
|
| - T value() const { return value_; }
|
| -
|
| - // Prints the held value as an action's result to os.
|
| - void PrintAsActionResult(::std::ostream* os) const {
|
| - *os << "\n Returns: ";
|
| - UniversalPrinter<T>::Print(value_, os);
|
| - }
|
| -
|
| - // Performs the given mock function's default action and returns the
|
| - // result in a ActionResultHolder.
|
| - template <typename Function, typename Arguments>
|
| - static ActionResultHolder PerformDefaultAction(
|
| - const FunctionMockerBase<Function>* func_mocker,
|
| - const Arguments& args,
|
| - const string& call_description) {
|
| - return ActionResultHolder(
|
| - func_mocker->PerformDefaultAction(args, call_description));
|
| - }
|
| -
|
| - // Performs the given action and returns the result in a
|
| - // ActionResultHolder.
|
| - template <typename Function, typename Arguments>
|
| - static ActionResultHolder PerformAction(const Action<Function>& action,
|
| - const Arguments& args) {
|
| - return ActionResultHolder(action.Perform(args));
|
| - }
|
| -
|
| - private:
|
| - T value_;
|
| -};
|
| -
|
| -// Specialization for T = void.
|
| -template <>
|
| -class ActionResultHolder<void> {
|
| - public:
|
| - ActionResultHolder() {}
|
| - void value() const {}
|
| - void PrintAsActionResult(::std::ostream* /* os */) const {}
|
| -
|
| - template <typename Function, typename Arguments>
|
| - static ActionResultHolder PerformDefaultAction(
|
| - const FunctionMockerBase<Function>* func_mocker,
|
| - const Arguments& args,
|
| - const string& call_description) {
|
| - func_mocker->PerformDefaultAction(args, call_description);
|
| - return ActionResultHolder();
|
| - }
|
| -
|
| - template <typename Function, typename Arguments>
|
| - static ActionResultHolder PerformAction(const Action<Function>& action,
|
| - const Arguments& args) {
|
| - action.Perform(args);
|
| - return ActionResultHolder();
|
| - }
|
| -};
|
| -
|
| -// The base of the function mocker class for the given function type.
|
| -// We put the methods in this class instead of its child to avoid code
|
| -// bloat.
|
| -template <typename F>
|
| -class FunctionMockerBase : public UntypedFunctionMockerBase {
|
| - public:
|
| - typedef typename Function<F>::Result Result;
|
| - typedef typename Function<F>::ArgumentTuple ArgumentTuple;
|
| - typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;
|
| -
|
| - FunctionMockerBase() : mock_obj_(NULL), name_(""), current_spec_(this) {}
|
| -
|
| - // The destructor verifies that all expectations on this mock
|
| - // function have been satisfied. If not, it will report Google Test
|
| - // non-fatal failures for the violations.
|
| - // L < g_gmock_mutex
|
| - virtual ~FunctionMockerBase() {
|
| - MutexLock l(&g_gmock_mutex);
|
| - VerifyAndClearExpectationsLocked();
|
| - Mock::UnregisterLocked(this);
|
| - }
|
| -
|
| - // Returns the ON_CALL spec that matches this mock function with the
|
| - // given arguments; returns NULL if no matching ON_CALL is found.
|
| - // L = *
|
| - const DefaultActionSpec<F>* FindDefaultActionSpec(
|
| - const ArgumentTuple& args) const {
|
| - for (typename std::vector<DefaultActionSpec<F> >::const_reverse_iterator it
|
| - = default_actions_.rbegin();
|
| - it != default_actions_.rend(); ++it) {
|
| - const DefaultActionSpec<F>& spec = *it;
|
| - if (spec.Matches(args))
|
| - return &spec;
|
| - }
|
| -
|
| - return NULL;
|
| - }
|
| -
|
| - // Performs the default action of this mock function on the given arguments
|
| - // and returns the result. Asserts with a helpful call descrption if there is
|
| - // no valid return value. This method doesn't depend on the mutable state of
|
| - // this object, and thus can be called concurrently without locking.
|
| - // L = *
|
| - Result PerformDefaultAction(const ArgumentTuple& args,
|
| - const string& call_description) const {
|
| - const DefaultActionSpec<F>* const spec = FindDefaultActionSpec(args);
|
| - if (spec != NULL) {
|
| - return spec->GetAction().Perform(args);
|
| - }
|
| - Assert(DefaultValue<Result>::Exists(), "", -1,
|
| - call_description + "\n The mock function has no default action "
|
| - "set, and its return type has no default value set.");
|
| - return DefaultValue<Result>::Get();
|
| - }
|
| -
|
| - // Registers this function mocker and the mock object owning it;
|
| - // returns a reference to the function mocker object. This is only
|
| - // called by the ON_CALL() and EXPECT_CALL() macros.
|
| - // L < g_gmock_mutex
|
| - FunctionMocker<F>& RegisterOwner(const void* mock_obj) {
|
| - {
|
| - MutexLock l(&g_gmock_mutex);
|
| - mock_obj_ = mock_obj;
|
| - }
|
| - Mock::Register(mock_obj, this);
|
| - return *::testing::internal::down_cast<FunctionMocker<F>*>(this);
|
| - }
|
| -
|
| - // The following two functions are from UntypedFunctionMockerBase.
|
| -
|
| - // Verifies that all expectations on this mock function have been
|
| - // satisfied. Reports one or more Google Test non-fatal failures
|
| - // and returns false if not.
|
| - // L >= g_gmock_mutex
|
| - virtual bool VerifyAndClearExpectationsLocked();
|
| -
|
| - // Clears the ON_CALL()s set on this mock function.
|
| - // L >= g_gmock_mutex
|
| - virtual void ClearDefaultActionsLocked() {
|
| - g_gmock_mutex.AssertHeld();
|
| - default_actions_.clear();
|
| - }
|
| -
|
| - // Sets the name of the function being mocked. Will be called upon
|
| - // each invocation of this mock function.
|
| - // L < g_gmock_mutex
|
| - void SetOwnerAndName(const void* mock_obj, const char* name) {
|
| - // We protect name_ under g_gmock_mutex in case this mock function
|
| - // is called from two threads concurrently.
|
| - MutexLock l(&g_gmock_mutex);
|
| - mock_obj_ = mock_obj;
|
| - name_ = name;
|
| - }
|
| -
|
| - // Returns the address of the mock object this method belongs to.
|
| - // Must be called after SetOwnerAndName() has been called.
|
| - // L < g_gmock_mutex
|
| - const void* MockObject() const {
|
| - const void* mock_obj;
|
| - {
|
| - // We protect mock_obj_ under g_gmock_mutex in case this mock
|
| - // function is called from two threads concurrently.
|
| - MutexLock l(&g_gmock_mutex);
|
| - mock_obj = mock_obj_;
|
| - }
|
| - return mock_obj;
|
| - }
|
| -
|
| - // Returns the name of the function being mocked. Must be called
|
| - // after SetOwnerAndName() has been called.
|
| - // L < g_gmock_mutex
|
| - const char* Name() const {
|
| - const char* name;
|
| - {
|
| - // We protect name_ under g_gmock_mutex in case this mock
|
| - // function is called from two threads concurrently.
|
| - MutexLock l(&g_gmock_mutex);
|
| - name = name_;
|
| - }
|
| - return name;
|
| - }
|
| - protected:
|
| - template <typename Function>
|
| - friend class MockSpec;
|
| -
|
| - // Returns the result of invoking this mock function with the given
|
| - // arguments. This function can be safely called from multiple
|
| - // threads concurrently.
|
| - // L < g_gmock_mutex
|
| - Result InvokeWith(const ArgumentTuple& args);
|
| -
|
| - // Adds and returns a default action spec for this mock function.
|
| - // L < g_gmock_mutex
|
| - DefaultActionSpec<F>& AddNewDefaultActionSpec(
|
| - const char* file, int line,
|
| - const ArgumentMatcherTuple& m) {
|
| - Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
|
| - default_actions_.push_back(DefaultActionSpec<F>(file, line, m));
|
| - return default_actions_.back();
|
| - }
|
| -
|
| - // Adds and returns an expectation spec for this mock function.
|
| - // L < g_gmock_mutex
|
| - TypedExpectation<F>& AddNewExpectation(
|
| - const char* file,
|
| - int line,
|
| - const string& source_text,
|
| - const ArgumentMatcherTuple& m) {
|
| - Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
|
| - const linked_ptr<TypedExpectation<F> > expectation(
|
| - new TypedExpectation<F>(this, file, line, source_text, m));
|
| - expectations_.push_back(expectation);
|
| -
|
| - // Adds this expectation into the implicit sequence if there is one.
|
| - Sequence* const implicit_sequence = g_gmock_implicit_sequence.get();
|
| - if (implicit_sequence != NULL) {
|
| - implicit_sequence->AddExpectation(Expectation(expectation));
|
| - }
|
| -
|
| - return *expectation;
|
| - }
|
| -
|
| - // The current spec (either default action spec or expectation spec)
|
| - // being described on this function mocker.
|
| - MockSpec<F>& current_spec() { return current_spec_; }
|
| - private:
|
| - template <typename Func> friend class TypedExpectation;
|
| -
|
| - typedef std::vector<internal::linked_ptr<TypedExpectation<F> > >
|
| - TypedExpectations;
|
| -
|
| - // Returns an Expectation object that references and co-owns exp,
|
| - // which must be an expectation on this mock function.
|
| - Expectation GetHandleOf(TypedExpectation<F>* exp) {
|
| - for (typename TypedExpectations::const_iterator it = expectations_.begin();
|
| - it != expectations_.end(); ++it) {
|
| - if (it->get() == exp) {
|
| - return Expectation(*it);
|
| - }
|
| - }
|
| -
|
| - Assert(false, __FILE__, __LINE__, "Cannot find expectation.");
|
| - return Expectation();
|
| - // The above statement is just to make the code compile, and will
|
| - // never be executed.
|
| - }
|
| -
|
| - // Some utilities needed for implementing InvokeWith().
|
| -
|
| - // Describes what default action will be performed for the given
|
| - // arguments.
|
| - // L = *
|
| - void DescribeDefaultActionTo(const ArgumentTuple& args,
|
| - ::std::ostream* os) const {
|
| - const DefaultActionSpec<F>* const spec = FindDefaultActionSpec(args);
|
| -
|
| - if (spec == NULL) {
|
| - *os << (internal::type_equals<Result, void>::value ?
|
| - "returning directly.\n" :
|
| - "returning default value.\n");
|
| - } else {
|
| - *os << "taking default action specified at:\n"
|
| - << spec->file() << ":" << spec->line() << ":\n";
|
| - }
|
| - }
|
| -
|
| - // Writes a message that the call is uninteresting (i.e. neither
|
| - // explicitly expected nor explicitly unexpected) to the given
|
| - // ostream.
|
| - // L < g_gmock_mutex
|
| - void DescribeUninterestingCall(const ArgumentTuple& args,
|
| - ::std::ostream* os) const {
|
| - *os << "Uninteresting mock function call - ";
|
| - DescribeDefaultActionTo(args, os);
|
| - *os << " Function call: " << Name();
|
| - UniversalPrinter<ArgumentTuple>::Print(args, os);
|
| - }
|
| -
|
| - // Critical section: We must find the matching expectation and the
|
| - // corresponding action that needs to be taken in an ATOMIC
|
| - // transaction. Otherwise another thread may call this mock
|
| - // method in the middle and mess up the state.
|
| - //
|
| - // However, performing the action has to be left out of the critical
|
| - // section. The reason is that we have no control on what the
|
| - // action does (it can invoke an arbitrary user function or even a
|
| - // mock function) and excessive locking could cause a dead lock.
|
| - // L < g_gmock_mutex
|
| - bool FindMatchingExpectationAndAction(
|
| - const ArgumentTuple& args, TypedExpectation<F>** exp, Action<F>* action,
|
| - bool* is_excessive, ::std::ostream* what, ::std::ostream* why) {
|
| - MutexLock l(&g_gmock_mutex);
|
| - *exp = this->FindMatchingExpectationLocked(args);
|
| - if (*exp == NULL) { // A match wasn't found.
|
| - *action = DoDefault();
|
| - this->FormatUnexpectedCallMessageLocked(args, what, why);
|
| - return false;
|
| - }
|
| -
|
| - // This line must be done before calling GetActionForArguments(),
|
| - // which will increment the call count for *exp and thus affect
|
| - // its saturation status.
|
| - *is_excessive = (*exp)->IsSaturated();
|
| - *action = (*exp)->GetActionForArguments(this, args, what, why);
|
| - return true;
|
| - }
|
| -
|
| - // Returns the expectation that matches the arguments, or NULL if no
|
| - // expectation matches them.
|
| - // L >= g_gmock_mutex
|
| - TypedExpectation<F>* FindMatchingExpectationLocked(
|
| - const ArgumentTuple& args) const {
|
| - g_gmock_mutex.AssertHeld();
|
| - for (typename TypedExpectations::const_reverse_iterator it =
|
| - expectations_.rbegin();
|
| - it != expectations_.rend(); ++it) {
|
| - TypedExpectation<F>* const exp = it->get();
|
| - if (exp->ShouldHandleArguments(args)) {
|
| - return exp;
|
| - }
|
| - }
|
| - return NULL;
|
| - }
|
| -
|
| - // Returns a message that the arguments don't match any expectation.
|
| - // L >= g_gmock_mutex
|
| - void FormatUnexpectedCallMessageLocked(const ArgumentTuple& args,
|
| - ::std::ostream* os,
|
| - ::std::ostream* why) const {
|
| - g_gmock_mutex.AssertHeld();
|
| - *os << "\nUnexpected mock function call - ";
|
| - DescribeDefaultActionTo(args, os);
|
| - PrintTriedExpectationsLocked(args, why);
|
| - }
|
| -
|
| - // Prints a list of expectations that have been tried against the
|
| - // current mock function call.
|
| - // L >= g_gmock_mutex
|
| - void PrintTriedExpectationsLocked(const ArgumentTuple& args,
|
| - ::std::ostream* why) const {
|
| - g_gmock_mutex.AssertHeld();
|
| - const int count = static_cast<int>(expectations_.size());
|
| - *why << "Google Mock tried the following " << count << " "
|
| - << (count == 1 ? "expectation, but it didn't match" :
|
| - "expectations, but none matched")
|
| - << ":\n";
|
| - for (int i = 0; i < count; i++) {
|
| - *why << "\n";
|
| - expectations_[i]->DescribeLocationTo(why);
|
| - if (count > 1) {
|
| - *why << "tried expectation #" << i << ": ";
|
| - }
|
| - *why << expectations_[i]->source_text() << "...\n";
|
| - expectations_[i]->DescribeMatchResultTo(args, why);
|
| - expectations_[i]->DescribeCallCountTo(why);
|
| - }
|
| - }
|
| -
|
| - // Address of the mock object this mock method belongs to. Only
|
| - // valid after this mock method has been called or
|
| - // ON_CALL/EXPECT_CALL has been invoked on it.
|
| - const void* mock_obj_; // Protected by g_gmock_mutex.
|
| -
|
| - // Name of the function being mocked. Only valid after this mock
|
| - // method has been called.
|
| - const char* name_; // Protected by g_gmock_mutex.
|
| -
|
| - // The current spec (either default action spec or expectation spec)
|
| - // being described on this function mocker.
|
| - MockSpec<F> current_spec_;
|
| -
|
| - // All default action specs for this function mocker.
|
| - std::vector<DefaultActionSpec<F> > default_actions_;
|
| - // All expectations for this function mocker.
|
| - TypedExpectations expectations_;
|
| -
|
| - // There is no generally useful and implementable semantics of
|
| - // copying a mock object, so copying a mock is usually a user error.
|
| - // Thus we disallow copying function mockers. If the user really
|
| - // wants to copy a mock object, he should implement his own copy
|
| - // operation, for example:
|
| - //
|
| - // class MockFoo : public Foo {
|
| - // public:
|
| - // // Defines a copy constructor explicitly.
|
| - // MockFoo(const MockFoo& src) {}
|
| - // ...
|
| - // };
|
| - GTEST_DISALLOW_COPY_AND_ASSIGN_(FunctionMockerBase);
|
| -}; // class FunctionMockerBase
|
| -
|
| -#ifdef _MSC_VER
|
| -#pragma warning(pop) // Restores the warning state.
|
| -#endif // _MSV_VER
|
| -
|
| -// Implements methods of FunctionMockerBase.
|
| -
|
| -// Verifies that all expectations on this mock function have been
|
| -// satisfied. Reports one or more Google Test non-fatal failures and
|
| -// returns false if not.
|
| -// L >= g_gmock_mutex
|
| -template <typename F>
|
| -bool FunctionMockerBase<F>::VerifyAndClearExpectationsLocked() {
|
| - g_gmock_mutex.AssertHeld();
|
| - bool expectations_met = true;
|
| - for (typename TypedExpectations::const_iterator it = expectations_.begin();
|
| - it != expectations_.end(); ++it) {
|
| - TypedExpectation<F>* const exp = it->get();
|
| -
|
| - if (exp->IsOverSaturated()) {
|
| - // There was an upper-bound violation. Since the error was
|
| - // already reported when it occurred, there is no need to do
|
| - // anything here.
|
| - expectations_met = false;
|
| - } else if (!exp->IsSatisfied()) {
|
| - expectations_met = false;
|
| - ::std::stringstream ss;
|
| - ss << "Actual function call count doesn't match "
|
| - << exp->source_text() << "...\n";
|
| - // No need to show the source file location of the expectation
|
| - // in the description, as the Expect() call that follows already
|
| - // takes care of it.
|
| - exp->MaybeDescribeExtraMatcherTo(&ss);
|
| - exp->DescribeCallCountTo(&ss);
|
| - Expect(false, exp->file(), exp->line(), ss.str());
|
| - }
|
| - }
|
| - expectations_.clear();
|
| - return expectations_met;
|
| -}
|
| -
|
| -// Reports an uninteresting call (whose description is in msg) in the
|
| -// manner specified by 'reaction'.
|
| -void ReportUninterestingCall(CallReaction reaction, const string& msg);
|
| -
|
| -// Calculates the result of invoking this mock function with the given
|
| -// arguments, prints it, and returns it.
|
| -// L < g_gmock_mutex
|
| -template <typename F>
|
| -typename Function<F>::Result FunctionMockerBase<F>::InvokeWith(
|
| - const typename Function<F>::ArgumentTuple& args) {
|
| - typedef ActionResultHolder<Result> ResultHolder;
|
| -
|
| - if (expectations_.size() == 0) {
|
| - // No expectation is set on this mock method - we have an
|
| - // uninteresting call.
|
| -
|
| - // We must get Google Mock's reaction on uninteresting calls
|
| - // made on this mock object BEFORE performing the action,
|
| - // because the action may DELETE the mock object and make the
|
| - // following expression meaningless.
|
| - const CallReaction reaction =
|
| - Mock::GetReactionOnUninterestingCalls(MockObject());
|
| -
|
| - // True iff we need to print this call's arguments and return
|
| - // value. This definition must be kept in sync with
|
| - // the behavior of ReportUninterestingCall().
|
| - const bool need_to_report_uninteresting_call =
|
| - // If the user allows this uninteresting call, we print it
|
| - // only when he wants informational messages.
|
| - reaction == ALLOW ? LogIsVisible(INFO) :
|
| - // If the user wants this to be a warning, we print it only
|
| - // when he wants to see warnings.
|
| - reaction == WARN ? LogIsVisible(WARNING) :
|
| - // Otherwise, the user wants this to be an error, and we
|
| - // should always print detailed information in the error.
|
| - true;
|
| -
|
| - if (!need_to_report_uninteresting_call) {
|
| - // Perform the action without printing the call information.
|
| - return PerformDefaultAction(args, "");
|
| - }
|
| -
|
| - // Warns about the uninteresting call.
|
| - ::std::stringstream ss;
|
| - DescribeUninterestingCall(args, &ss);
|
| -
|
| - // Calculates the function result.
|
| - const ResultHolder result =
|
| - ResultHolder::PerformDefaultAction(this, args, ss.str());
|
| -
|
| - // Prints the function result.
|
| - result.PrintAsActionResult(&ss);
|
| -
|
| - ReportUninterestingCall(reaction, ss.str());
|
| - return result.value();
|
| - }
|
| -
|
| - bool is_excessive = false;
|
| - ::std::stringstream ss;
|
| - ::std::stringstream why;
|
| - ::std::stringstream loc;
|
| - Action<F> action;
|
| - TypedExpectation<F>* exp;
|
| -
|
| - // The FindMatchingExpectationAndAction() function acquires and
|
| - // releases g_gmock_mutex.
|
| - const bool found = FindMatchingExpectationAndAction(
|
| - args, &exp, &action, &is_excessive, &ss, &why);
|
| -
|
| - // True iff we need to print the call's arguments and return value.
|
| - // This definition must be kept in sync with the uses of Expect()
|
| - // and Log() in this function.
|
| - const bool need_to_report_call = !found || is_excessive || LogIsVisible(INFO);
|
| - if (!need_to_report_call) {
|
| - // Perform the action without printing the call information.
|
| - return action.IsDoDefault() ? PerformDefaultAction(args, "") :
|
| - action.Perform(args);
|
| - }
|
| -
|
| - ss << " Function call: " << Name();
|
| - UniversalPrinter<ArgumentTuple>::Print(args, &ss);
|
| -
|
| - // In case the action deletes a piece of the expectation, we
|
| - // generate the message beforehand.
|
| - if (found && !is_excessive) {
|
| - exp->DescribeLocationTo(&loc);
|
| - }
|
| -
|
| - const ResultHolder result = action.IsDoDefault() ?
|
| - ResultHolder::PerformDefaultAction(this, args, ss.str()) :
|
| - ResultHolder::PerformAction(action, args);
|
| - result.PrintAsActionResult(&ss);
|
| - ss << "\n" << why.str();
|
| -
|
| - if (!found) {
|
| - // No expectation matches this call - reports a failure.
|
| - Expect(false, NULL, -1, ss.str());
|
| - } else if (is_excessive) {
|
| - // We had an upper-bound violation and the failure message is in ss.
|
| - Expect(false, exp->file(), exp->line(), ss.str());
|
| - } else {
|
| - // We had an expected call and the matching expectation is
|
| - // described in ss.
|
| - Log(INFO, loc.str() + ss.str(), 2);
|
| - }
|
| - return result.value();
|
| -}
|
| -
|
| -} // namespace internal
|
| -
|
| -// The style guide prohibits "using" statements in a namespace scope
|
| -// inside a header file. However, the MockSpec class template is
|
| -// meant to be defined in the ::testing namespace. The following line
|
| -// is just a trick for working around a bug in MSVC 8.0, which cannot
|
| -// handle it if we define MockSpec in ::testing.
|
| -using internal::MockSpec;
|
| -
|
| -// Const(x) is a convenient function for obtaining a const reference
|
| -// to x. This is useful for setting expectations on an overloaded
|
| -// const mock method, e.g.
|
| -//
|
| -// class MockFoo : public FooInterface {
|
| -// public:
|
| -// MOCK_METHOD0(Bar, int());
|
| -// MOCK_CONST_METHOD0(Bar, int&());
|
| -// };
|
| -//
|
| -// MockFoo foo;
|
| -// // Expects a call to non-const MockFoo::Bar().
|
| -// EXPECT_CALL(foo, Bar());
|
| -// // Expects a call to const MockFoo::Bar().
|
| -// EXPECT_CALL(Const(foo), Bar());
|
| -template <typename T>
|
| -inline const T& Const(const T& x) { return x; }
|
| -
|
| -// Constructs an Expectation object that references and co-owns exp.
|
| -inline Expectation::Expectation(internal::ExpectationBase& exp) // NOLINT
|
| - : expectation_base_(exp.GetHandle().expectation_base()) {}
|
| -
|
| -} // namespace testing
|
| -
|
| -// A separate macro is required to avoid compile errors when the name
|
| -// of the method used in call is a result of macro expansion.
|
| -// See CompilesWithMethodNameExpandedFromMacro tests in
|
| -// internal/gmock-spec-builders_test.cc for more details.
|
| -#define GMOCK_ON_CALL_IMPL_(obj, call) \
|
| - ((obj).gmock_##call).InternalDefaultActionSetAt(__FILE__, __LINE__, \
|
| - #obj, #call)
|
| -#define ON_CALL(obj, call) GMOCK_ON_CALL_IMPL_(obj, call)
|
| -
|
| -#define GMOCK_EXPECT_CALL_IMPL_(obj, call) \
|
| - ((obj).gmock_##call).InternalExpectedAt(__FILE__, __LINE__, #obj, #call)
|
| -#define EXPECT_CALL(obj, call) GMOCK_EXPECT_CALL_IMPL_(obj, call)
|
| -
|
| -#endif // GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_
|
|
|