ReturnObjectList.h

Go to the documentation of this file.

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

   begin                : Sat Dec 21 2002
   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_RETURNOBJECTLIST_H
#define MOCKPP_RETURNOBJECTLIST_H

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

#include MOCKPP_VECTOR_H

#include <mockpp/Verifiable.h>

#include <mockpp/compat/Formatter.h>

#include <mockpp/util/AssertMo.h>


MOCKPP_NS_START


class VerifiableList;

template <class T>
class ReturnObjectList : public Verifiable
{
  public:

    ReturnObjectList(const String &name, VerifiableList *parent)
     : Verifiable (name, parent)
     , haveDefault(false)
    {
    }


    ReturnObjectList& addObjectToReturn(const T &anObjectToReturn)
    {
      myObjects.push_back(anObjectToReturn);
      return *this;
    }


    ReturnObjectList& addObjectToReturn(const T &anObjectToReturn, unsigned count)
    {
      for (unsigned i = 0; i < count; ++i)
        addObjectToReturn(anObjectToReturn);
      return *this;
    }


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


    void setDefaultReturnValue(const T &defaultObj)
    {
      haveDefault = true;
      defaultObject = defaultObj;
    }


    T nextReturnObject()
    {
      String fmt = mockpp_i18n(MOCKPP_PCHAR("%1 has run out of objects."));
      fmt << getVerifiableName();

      if (myObjects.size() == 0 && haveDefault)
        return defaultObject;

      MOCKPP_ASSERT_TRUE_MESSAGE(fmt, myObjects.size() > 0);

      T temp = myObjects[0];
      myObjects.erase(myObjects.begin());
      return temp;
    }


    void reset()
    {
      haveDefault = false;
      myObjects.clear();
    }


    String toString() const // virtual
    {
      if (myObjects.size() == 0 && !haveDefault)
        return MOCKPP_PCHAR("[]");

      String ret;
      ret += MOCKPP_PCHAR("\n[\n");

      for(unsigned i = 0; i < myObjects.size(); ++i)
      {
        String fmt = MOCKPP_PCHAR(" - %1\n");
        fmt << myObjects[i];
        ret += fmt;
      }

      if (haveDefault)
      {
        String fmt = MOCKPP_PCHAR(" * %1\n");
        fmt << defaultObject;
        ret += fmt;
      }

      ret += MOCKPP_PCHAR("]\n");
      return ret;
    }


    bool hasMoreObjects() const
    {
      return myObjects.size() != 0;
    }


    virtual void verify()
    {
      String fmt = mockpp_i18n(MOCKPP_PCHAR("%1 has %2 un-used objects."));
      fmt << getVerifiableName() << myObjects.size();

      MOCKPP_ASSERT_EQUALS_MESSAGE(fmt, (size_t)0, myObjects.size());
    }

  private:

    MOCKPP_STL::vector<T>  myObjects;
    bool                   haveDefault;
    T                      defaultObject;
};


MOCKPP_NS_END

#endif // MOCKPP_RETURNOBJECTLIST_H

---