OutBound.h

Go to the documentation of this file.

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

   begin                : Sat Jul 22 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_OutBound_H
#define MOCKPP_OutBound_H

#include <mockpp/mockpp.h> // always first

#include <mockpp/constraint/Constraint.h>
#include <mockpp/compat/Formatter.h>
#include <mockpp/ReturnObjectList.h>


MOCKPP_NS_START


template <typename T>
class OutBound : public Constraint<T>
{
  public:

    OutBound( const T &retArg )
      : returnObjects(MOCKPP_PCHAR("OutBound/returnObjects"), 0)
    {
      addOutboundObject(retArg);
    }

    template <class I>
    OutBound( I items, I end )
      : returnObjects(MOCKPP_PCHAR("Outbound/returnObjects"), 0)
    {
      addOutboundObject(items, end);
    }

    void addOutboundObject( const T &retArg )
    {
      returnObjects.addObjectToReturn(retArg);
    }

    template <class I>
    OutBound& addOutboundObject(I items, I end)
    {
      for ( /* -- */; items != end; ++items)
        addOutboundObject(*items);
      return *this;
    }

    virtual ~OutBound()
    {}

    virtual bool eval( const T &arg ) const
    {
      if (returnObjects.hasMoreObjects())
      {
        T &back_ref = const_cast<T&>(arg);
        back_ref = returnObjects.nextReturnObject();
        return true;
      }

      return false;
    }

    virtual bool verify( const T & /*arg*/ ) const
    {
      return returnObjects.hasMoreObjects() == 0;
    }

    virtual String describeTo( String &buffer ) const
    {
      String fmt = MOCKPP_PCHAR("returns %1");
      fmt << returnObjects.toString();
      buffer += fmt;
      return buffer;
    }

  private:

    mutable ReturnObjectList<T> returnObjects;
};


MOCKPP_NS_END


#endif // MOCKPP_OutBound_H

---