VisitableMockMethod.h

Go to the documentation of this file.

/**************************************************************************

   begin                : Thu Oct 2 2005
   copyright            : (C) 2002-2010 by Ewald Arnold
   email                : mockpp at ewald-arnold dot de

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2 of the License,
   or (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

 **/


#ifndef MOCKPP_VisitableMockMethod_H
#define MOCKPP_VisitableMockMethod_H

#include <mockpp/mockpp.h>

#include <mockpp/visiting/VisitableMockObject.h>
//#include <mockpp/CountedVisitableMethod.h>


MOCKPP_NS_START


class MOCKPP_API_DECL0 VisitableMockMethodBase : public MockObject
{
  public:

    VisitableMockMethodBase(const String &name, VisitableMockObject *parent);

    String getMethodName(bool fully = false) const;

    MOCKPP_STL::string getMethodIdentifier() const;

    VisitableMockObject *getVisitableMockObject() const;

  protected:

    void throwAvailableException() const
    {
      bool do_throw = true;
      if (throwablesInline)
      {
        unsigned num = throwableInsteadReturn.size();
        if (num != 0)
        {
          do_throw = throwableInsteadReturn[0];
          throwableInsteadReturn.erase(throwableInsteadReturn.begin());
        }
      }

      if (do_throw && throwables.hasMoreObjects() != 0)
      {
        Throwable *thr = throwables.nextThrowableObject();
        if (thr != 0)
          thr->throw_me();
      }

      if (defaultThrowable.get() != 0)
        defaultThrowable.get()->throw_me();
    }

    //-------------------------------------------------------------

  public:

    void unsetThrowablesInline()
    {
      MOCKPP_ASSERT_FALSE(this->getVisitableMockObject()->isActivated());
      this->throwablesInline = false;
    };

    void addThrowable(Throwable *t)
    {
      MOCKPP_STD_NS::auto_ptr<Throwable> at (t);
      MOCKPP_ASSERT_FALSE(this->getVisitableMockObject()->isActivated());
      this->throwables.push_back(at.release());
      this->throwableInsteadReturn.push_back(true);
    }

    template <class T>
    void addThrowable(const T &w, unsigned count = 1)
    {
      for ( ; count > 0; --count)
        addThrowable(make_throwable(w));
    }

    void setDefaultThrowable(Throwable *t)
    {
      MOCKPP_STD_NS::auto_ptr<Throwable> at (t);
      MOCKPP_ASSERT_FALSE(this->getVisitableMockObject()->isActivated());
      this->defaultThrowable.take(at.release());
    }

    virtual void reset()
    {
      this->defaultThrowable.reset();
      this->throwables.reset();
      this->throwableInsteadReturn.clear();
      this->throwablesInline = true;
    }

    virtual void verify()
    {
      Throwable *dt = this->defaultThrowable.get();
      if (dt != 0)
      {
        String fmt = mockpp_i18n(MOCKPP_PCHAR("%1 is unused."));
        fmt << (this->getMethodName() + MOCKPP_PCHAR("/defaultThrowable"));
        MOCKPP_ASSERT_TRUE_MESSAGE(fmt, dt->hasThrown());
      }
    }

  protected:

    VisitableMockObject         *visitable;                     
    mutable ThrowableItem        defaultThrowable;              
    mutable ThrowableList        throwables;                    
    mutable bool                 throwablesInline;              
    mutable MOCKPP_STL::vector<bool>    throwableInsteadReturn; 
};




template <typename R>
class VisitableMockReturningMethodBase : public VisitableMockMethodBase
{
  public:

    VisitableMockReturningMethodBase(const String &name, VisitableMockObject *parent)
      : VisitableMockMethodBase(name, parent)
      , returnValues(getMethodName() + MOCKPP_PCHAR("/returnValues"), this)
    {
      reset();
    }

    void setDefaultReturnValue(const R &rv)
    {
      MOCKPP_ASSERT_FALSE(this->getVisitableMockObject()->isActivated());
      this->haveDefaultReturnValue = true;
      this->defaultReturnValue = rv;
    }

    void addReturnValue(const R &rv, unsigned count = 1)
    {
      MOCKPP_ASSERT_FALSE(this->getVisitableMockObject()->isActivated());
      for ( ; count > 0; --count)
      {
        this->returnValues.addObjectToReturn(rv);
        this->throwableInsteadReturn.push_back(false);
      }
    }

    virtual void reset()
    {
      VisitableMockMethodBase::reset();
      this->returnValues.reset();
      this->haveDefaultReturnValue = false;
      this->defaultReturnValueUsed = false;
    }

    virtual void verify()
    {
      VisitableMockMethodBase::verify();
      if (this->haveDefaultReturnValue)
      {
        String fmt = mockpp_i18n(MOCKPP_PCHAR("%1 is unused."));
        fmt << (this->getMethodName() + MOCKPP_PCHAR("/defaultReturnValueUsed"));
        MOCKPP_ASSERT_TRUE_MESSAGE(fmt, this->defaultReturnValueUsed);
      }
    }

  protected:

    R determineReturnValue() const
    {
//      throwableInsteadReturn.erase(throwableInsteadReturn.begin());
      if (returnValues.hasMoreObjects())
        return returnValues.nextReturnObject();

      MOCKPP_ASSERT_TRUE_MESSAGE(this->getMethodName(true) + MOCKPP_PCHAR("haveDefaultReturnValue != true"),
                                 haveDefaultReturnValue == true);
      defaultReturnValueUsed = true;
      return defaultReturnValue;
    }

  protected:

    mutable ReturnObjectList<R>         returnValues;              
    bool                                haveDefaultReturnValue;    
    mutable bool                        defaultReturnValueUsed;    
    R                                   defaultReturnValue;        
};


template <>
class VisitableMockReturningMethodBase<void> : public VisitableMockMethodBase
{
  public:

    VisitableMockReturningMethodBase(const String &name, VisitableMockObject *parent)
      : VisitableMockMethodBase(name, parent)
    {}
};


MOCKPP_NS_END


#endif // MOCKPP_VisitableMockMethod_H

---