testing::internal::ExpectationBase Class Reference

#include <gmock-spec-builders.h>

Inheritance diagram for testing::internal::ExpectationBase:

Collaboration diagram for testing::internal::ExpectationBase:

Public Member Functions
	ExpectationBase (const char *file, int line, const std::string &source_text)
virtual	~ExpectationBase ()
const char *	file () const
int	line () const
const char *	source_text () const
const Cardinality &	cardinality () const
void	DescribeLocationTo (::std::ostream *os) const
void	DescribeCallCountTo (::std::ostream *os) const GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
virtual void	MaybeDescribeExtraMatcherTo (::std::ostream *os)=0

Protected Types
enum	Clause {   kNone , kWith , kTimes , kInSequence ,   kAfter , kWillOnce , kWillRepeatedly , kRetiresOnSaturation }
typedef std::vector< const void * >	UntypedActions

Protected Member Functions
virtual Expectation	GetHandle ()=0
void	AssertSpecProperty (bool property, const std::string &failure_message) const
void	ExpectSpecProperty (bool property, const std::string &failure_message) const
void	SpecifyCardinality (const Cardinality &cardinality)
bool	cardinality_specified () const
void	set_cardinality (const Cardinality &a_cardinality)
void	RetireAllPreRequisites () GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
bool	is_retired () const GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
void	Retire () GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
bool	IsSatisfied () const GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
bool	IsSaturated () const GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
bool	IsOverSaturated () const GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
bool	AllPrerequisitesAreSatisfied () const GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
void	FindUnsatisfiedPrerequisites (ExpectationSet *result) const GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
int	call_count () const GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
void	IncrementCallCount () GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex)
void	CheckActionCountIfNotDone () const GTEST_LOCK_EXCLUDED_(mutex_)
void	UntypedTimes (const Cardinality &a_cardinality)
	GTEST_DISALLOW_ASSIGN_ (ExpectationBase)

Protected Attributes
const char *	file_
int	line_
const std::string	source_text_
bool	cardinality_specified_
Cardinality	cardinality_
ExpectationSet	immediate_prerequisites_
int	call_count_
bool	retired_
UntypedActions	untyped_actions_
bool	extra_matcher_specified_
bool	repeated_action_specified_
bool	retires_on_saturation_
Clause	last_clause_
bool	action_count_checked_
Mutex	mutex_

Friends
class	::testing::Expectation
class	UntypedFunctionMockerBase
class	::testing::Sequence
class	::testing::internal::ExpectationTester
template<typename Function >
class	TypedExpectation

Detailed Description

Definition at line 695 of file gmock-spec-builders.h.

Member Typedef Documentation

UntypedActions

std::vector<const void*> testing::internal::ExpectationBase::UntypedActions

protected

Definition at line 739 of file gmock-spec-builders.h.

Member Enumeration Documentation

Clause

enum testing::internal::ExpectationBase::Clause

protected

Enumerator
kNone
kWith
kTimes
kInSequence
kAfter
kWillOnce
kWillRepeatedly
kRetiresOnSaturation

Definition at line 727 of file gmock-spec-builders.h.

              {
    // Don't change the order of the enum members!
    kNone,
    kWith,
    kTimes,
    kInSequence,
    kAfter,
    kWillOnce,
    kWillRepeatedly,
    kRetiresOnSaturation
  };

Constructor & Destructor Documentation

ExpectationBase()

testing::internal::ExpectationBase::ExpectationBase	(	const char *	file,
		int	line,
		const std::string &	source_text )

Definition at line 78 of file gmock-spec-builders.cc.

    : file_(a_file),
      line_(a_line),
      source_text_(a_source_text),
      cardinality_specified_(false),
      cardinality_(Exactly(1)),
      call_count_(0),
      retired_(false),
      extra_matcher_specified_(false),
      repeated_action_specified_(false),
      retires_on_saturation_(false),
      last_clause_(kNone),
      action_count_checked_(false) {}

~ExpectationBase()

testing::internal::ExpectationBase::~ExpectationBase ( )

virtual

Definition at line 94 of file gmock-spec-builders.cc.

{}

Member Function Documentation

AllPrerequisitesAreSatisfied()

bool testing::internal::ExpectationBase::AllPrerequisitesAreSatisfied ( ) const

protected

Definition at line 131 of file gmock-spec-builders.cc.

                                                  {
  g_gmock_mutex.AssertHeld();
  ::std::vector<const ExpectationBase*> expectations(1, this);
  while (!expectations.empty()) {
    const ExpectationBase* exp = expectations.back();
    expectations.pop_back();
 
    for (ExpectationSet::const_iterator it =
             exp->immediate_prerequisites_.begin();
         it != exp->immediate_prerequisites_.end(); ++it) {
      const ExpectationBase* next = it->expectation_base().get();
      if (!next->IsSatisfied()) return false;
      expectations.push_back(next);
    }
  }
  return true;
}

Here is the call graph for this function:

AssertSpecProperty()

void testing::internal::ExpectationBase::AssertSpecProperty ( bool property, const std::string & failure_message ) const

inlineprotected

Definition at line 746 of file gmock-spec-builders.h.

                                                                  {
    Assert(property, file_, line_, failure_message);
  }

Here is the call graph for this function:

call_count()

int testing::internal::ExpectationBase::call_count ( ) const

inlineprotected

Definition at line 822 of file gmock-spec-builders.h.

                                                    {
    g_gmock_mutex.AssertHeld();
    return call_count_;
  }

cardinality()

const Cardinality & testing::internal::ExpectationBase::cardinality ( ) const

inline

Definition at line 707 of file gmock-spec-builders.h.

{ return cardinality_; }

Here is the caller graph for this function:

cardinality_specified()

bool testing::internal::ExpectationBase::cardinality_specified ( ) const

inlineprotected

Definition at line 763 of file gmock-spec-builders.h.

{ return cardinality_specified_; }

CheckActionCountIfNotDone()

void testing::internal::ExpectationBase::CheckActionCountIfNotDone ( ) const

protected

Definition at line 205 of file gmock-spec-builders.cc.

                                 {
  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>(untyped_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(kWarning, ss.str(), -1);  // -1 means "don't print stack trace".
  }
}

Here is the call graph for this function:

DescribeCallCountTo()

void testing::internal::ExpectationBase::DescribeCallCountTo

(

::std::ostream *

os

)

const

Definition at line 182 of file gmock-spec-builders.cc.

                                                  {
  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");
}

Here is the call graph for this function:

DescribeLocationTo()

void testing::internal::ExpectationBase::DescribeLocationTo ( ::std::ostream * os ) const

inline

Definition at line 710 of file gmock-spec-builders.h.

                                                {
    *os << FormatFileLocation(file(), line()) << " ";
  }

Here is the caller graph for this function:

ExpectSpecProperty()

void testing::internal::ExpectationBase::ExpectSpecProperty ( bool property, const std::string & failure_message ) const

inlineprotected

Definition at line 752 of file gmock-spec-builders.h.

                                                                  {
    Expect(property, file_, line_, failure_message);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

file()

const char * testing::internal::ExpectationBase::file ( ) const

inline

Definition at line 703 of file gmock-spec-builders.h.

{ return file_; }

Here is the caller graph for this function:

FindUnsatisfiedPrerequisites()

void testing::internal::ExpectationBase::FindUnsatisfiedPrerequisites ( ExpectationSet * result ) const

protected

Definition at line 151 of file gmock-spec-builders.cc.

                                                  {
  g_gmock_mutex.AssertHeld();
  ::std::vector<const ExpectationBase*> expectations(1, this);
  while (!expectations.empty()) {
    const ExpectationBase* exp = expectations.back();
    expectations.pop_back();
 
    for (ExpectationSet::const_iterator it =
             exp->immediate_prerequisites_.begin();
         it != exp->immediate_prerequisites_.end(); ++it) {
      const ExpectationBase* next = it->expectation_base().get();
 
      if (next->IsSatisfied()) {
        // If *it is satisfied and has a call count of 0, some of its
        // pre-requisites may not be satisfied yet.
        if (next->call_count_ == 0) {
          expectations.push_back(next);
        }
      } else {
        // Now that we know next is unsatisfied, we are not so interested
        // in whether its pre-requisites are satisfied.  Therefore we
        // don't iterate into it here.
        *result += *it;
      }
    }
  }
}

Here is the call graph for this function:

GetHandle()

virtual Expectation testing::internal::ExpectationBase::GetHandle ( )

protectedpure virtual

GTEST_DISALLOW_ASSIGN_()

testing::internal::ExpectationBase::GTEST_DISALLOW_ASSIGN_ ( ExpectationBase )

protected

IncrementCallCount()

void testing::internal::ExpectationBase::IncrementCallCount ( )

inlineprotected

Definition at line 829 of file gmock-spec-builders.h.

                                                    {
    g_gmock_mutex.AssertHeld();
    call_count_++;
  }

is_retired()

bool testing::internal::ExpectationBase::is_retired ( ) const

inlineprotected

Definition at line 779 of file gmock-spec-builders.h.

                                                    {
    g_gmock_mutex.AssertHeld();
    return retired_;
  }

Here is the caller graph for this function:

IsOverSaturated()

bool testing::internal::ExpectationBase::IsOverSaturated ( ) const

inlineprotected

Definition at line 807 of file gmock-spec-builders.h.

                                                    {
    g_gmock_mutex.AssertHeld();
    return cardinality().IsOverSaturatedByCallCount(call_count_);
  }

IsSatisfied()

bool testing::internal::ExpectationBase::IsSatisfied ( ) const

inlineprotected

Definition at line 793 of file gmock-spec-builders.h.

                                                    {
    g_gmock_mutex.AssertHeld();
    return cardinality().IsSatisfiedByCallCount(call_count_);
  }

IsSaturated()

bool testing::internal::ExpectationBase::IsSaturated ( ) const

inlineprotected

Definition at line 800 of file gmock-spec-builders.h.

                                                    {
    g_gmock_mutex.AssertHeld();
    return cardinality().IsSaturatedByCallCount(call_count_);
  }

line()

int testing::internal::ExpectationBase::line ( ) const

inline

Definition at line 704 of file gmock-spec-builders.h.

{ return line_; }

Here is the caller graph for this function:

MaybeDescribeExtraMatcherTo()

virtual void testing::internal::ExpectationBase::MaybeDescribeExtraMatcherTo ( ::std::ostream * os )

pure virtual

Implemented in testing::internal::TypedExpectation< F >.

Retire()

void testing::internal::ExpectationBase::Retire ( )

inlineprotected

Definition at line 786 of file gmock-spec-builders.h.

                                                    {
    g_gmock_mutex.AssertHeld();
    retired_ = true;
  }

RetireAllPreRequisites()

void testing::internal::ExpectationBase::RetireAllPreRequisites ( )

protected

Definition at line 104 of file gmock-spec-builders.cc.

                                                  {
  if (is_retired()) {
    // We can take this short-cut as we never retire an expectation
    // until we have retired all its pre-requisites.
    return;
  }
 
  ::std::vector<ExpectationBase*> expectations(1, this);
  while (!expectations.empty()) {
    ExpectationBase* exp = expectations.back();
    expectations.pop_back();
 
    for (ExpectationSet::const_iterator it =
             exp->immediate_prerequisites_.begin();
         it != exp->immediate_prerequisites_.end(); ++it) {
      ExpectationBase* next = it->expectation_base().get();
      if (!next->is_retired()) {
        next->Retire();
        expectations.push_back(next);
      }
    }
  }
}

Here is the call graph for this function:

set_cardinality()

void testing::internal::ExpectationBase::set_cardinality ( const Cardinality & a_cardinality )

inlineprotected

Definition at line 766 of file gmock-spec-builders.h.

                                                         {
    cardinality_ = a_cardinality;
  }

source_text()

const char * testing::internal::ExpectationBase::source_text ( ) const

inline

Definition at line 705 of file gmock-spec-builders.h.

{ return source_text_.c_str(); }

Here is the caller graph for this function:

SpecifyCardinality()

void testing::internal::ExpectationBase::SpecifyCardinality ( const Cardinality & cardinality )

protected

Definition at line 98 of file gmock-spec-builders.cc.

                                                                         {
  cardinality_specified_ = true;
  cardinality_ = a_cardinality;
}

Here is the caller graph for this function:

UntypedTimes()

void testing::internal::ExpectationBase::UntypedTimes ( const Cardinality & a_cardinality )

protected

Definition at line 257 of file gmock-spec-builders.cc.

                                                                   {
  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;
 
  SpecifyCardinality(a_cardinality);
}

Here is the call graph for this function:

Friends And Related Symbol Documentation

::testing::Expectation

friend class ::testing::Expectation

friend

Definition at line 724 of file gmock-spec-builders.h.

::testing::internal::ExpectationTester

friend class ::testing::internal::ExpectationTester

friend

Definition at line 843 of file gmock-spec-builders.h.

::testing::Sequence

friend class ::testing::Sequence

friend

Definition at line 842 of file gmock-spec-builders.h.

TypedExpectation

template<typename Function >

friend class TypedExpectation

friend

Definition at line 846 of file gmock-spec-builders.h.

UntypedFunctionMockerBase

friend class UntypedFunctionMockerBase

friend

Definition at line 725 of file gmock-spec-builders.h.

Member Data Documentation

action_count_checked_

bool testing::internal::ExpectationBase::action_count_checked_

mutableprotected

Definition at line 876 of file gmock-spec-builders.h.

call_count_

int testing::internal::ExpectationBase::call_count_

protected

Definition at line 869 of file gmock-spec-builders.h.

cardinality_

Cardinality testing::internal::ExpectationBase::cardinality_

protected

Definition at line 858 of file gmock-spec-builders.h.

cardinality_specified_

bool testing::internal::ExpectationBase::cardinality_specified_

protected

Definition at line 857 of file gmock-spec-builders.h.

extra_matcher_specified_

bool testing::internal::ExpectationBase::extra_matcher_specified_

protected

Definition at line 872 of file gmock-spec-builders.h.

file_

const char* testing::internal::ExpectationBase::file_

protected

Definition at line 853 of file gmock-spec-builders.h.

immediate_prerequisites_

ExpectationSet testing::internal::ExpectationBase::immediate_prerequisites_

protected

Definition at line 865 of file gmock-spec-builders.h.

last_clause_

Clause testing::internal::ExpectationBase::last_clause_

protected

Definition at line 875 of file gmock-spec-builders.h.

line_

int testing::internal::ExpectationBase::line_

protected

Definition at line 854 of file gmock-spec-builders.h.

mutex_

Mutex testing::internal::ExpectationBase::mutex_

mutableprotected

Definition at line 877 of file gmock-spec-builders.h.

repeated_action_specified_

bool testing::internal::ExpectationBase::repeated_action_specified_

protected

Definition at line 873 of file gmock-spec-builders.h.

retired_

bool testing::internal::ExpectationBase::retired_

protected

Definition at line 870 of file gmock-spec-builders.h.

retires_on_saturation_

bool testing::internal::ExpectationBase::retires_on_saturation_

protected

Definition at line 874 of file gmock-spec-builders.h.

source_text_

const std::string testing::internal::ExpectationBase::source_text_

protected

Definition at line 855 of file gmock-spec-builders.h.

untyped_actions_

UntypedActions testing::internal::ExpectationBase::untyped_actions_

protected

Definition at line 871 of file gmock-spec-builders.h.

---

The documentation for this class was generated from the following files:

• libraries/fc/include/fc/crypto/webauthn_json/thirdparty/gtest/googlemock/include/gmock/gmock-spec-builders.h
• libraries/fc/include/fc/crypto/webauthn_json/thirdparty/gtest/googlemock/src/gmock-spec-builders.cc