rwTemplatedList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2013 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "vrfutil/rwList.h"
#include "vrfutil/iteratorBase.h"
#include "vrfutil/bufferSerialize.h"

template <typename T, bool T_autoDelete = false>
class DtRwTemplatedListPtr : public DtRwList
{
public:
   typedef DtIteratorBase<T> iterator;
   typedef DtIteratorBase<const T> const_iterator;

   DtRwTemplatedListPtr();

   DtRwTemplatedListPtr(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);
   DtRwTemplatedListPtr(const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwTemplatedListPtr(const DtString& name,  const DtRwTemplatedListPtr& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwTemplatedListPtr(const DtSymbolString& name,  const DtRwTemplatedListPtr& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwTemplatedListPtr(const DtRwTemplatedListPtr& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwTemplatedListPtr& operator=(const DtRwTemplatedListPtr& orig);

   virtual ~DtRwTemplatedListPtr();

   DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   virtual DtListItem* add(T* data) {return DtRwList::add(data);};

   void removeAll();
   void* remove(DtListItem* item);
   void* remove(T* item);

   void removeAndDeleteAll();

   bool operator==(const DtRwTemplatedListPtr&) const;
   bool operator!=(const DtRwTemplatedListPtr&) const;

public:

   void setAutoDelete(bool b) { myAutoDelete = b; };
   bool autoDelete() const { return myAutoDelete; };

   const char* readerWriterType() const;

   static const char* ListReaderWriterType();

   void copyList(const DtRwTemplatedListPtr& orig);

protected:
   bool myAutoDelete;
};

namespace DtBufferSerialize
{
   template <typename T, bool T_autoDelete>
   int getSize(const DtRwTemplatedListPtr<T, T_autoDelete>& val);

   template <typename T, bool T_autoDelete>
   char *encode(const DtRwTemplatedListPtr<T, T_autoDelete>& val, char *buffer);

   template <typename T, bool T_autoDelete>
   const char *decode(DtRwTemplatedListPtr<T, T_autoDelete>& val, const char *buffer) ;
};

template <typename T, bool T_autoDelete>
DtRwTemplatedListPtr<T, T_autoDelete>::DtRwTemplatedListPtr() :
   DtRwList(),
myAutoDelete(T_autoDelete)
{
}

template <typename T, bool T_autoDelete>
DtRwTemplatedListPtr<T, T_autoDelete>::DtRwTemplatedListPtr(const DtString& name, DtReaderWriterRegistry * parentRegistry) :
   DtRwList(name, parentRegistry),
myAutoDelete(T_autoDelete)
{
}

template <typename T, bool T_autoDelete>
DtRwTemplatedListPtr<T, T_autoDelete>::DtRwTemplatedListPtr(const DtSymbolString& name, DtReaderWriterRegistry * parentRegistry) :
   DtRwList(name, parentRegistry),
myAutoDelete(T_autoDelete)
{
}

template <typename T, bool T_autoDelete>
DtRwTemplatedListPtr<T, T_autoDelete>::DtRwTemplatedListPtr(const DtString& name,  const DtRwTemplatedListPtr<T, T_autoDelete>& orig, 
   DtReaderWriterRegistry * parentRegistry) :
DtRwList(name, orig, parentRegistry),
myAutoDelete(orig.myAutoDelete)
{
   copyList(orig);
}

template <typename T, bool T_autoDelete>
DtRwTemplatedListPtr<T, T_autoDelete>::DtRwTemplatedListPtr(const DtSymbolString& name,  const DtRwTemplatedListPtr<T, T_autoDelete>& orig, 
   DtReaderWriterRegistry * parentRegistry) :
DtRwList(name, orig, parentRegistry),
myAutoDelete(orig.myAutoDelete)
{
   copyList(orig);
}

template <typename T, bool T_autoDelete>
DtRwTemplatedListPtr<T, T_autoDelete>::DtRwTemplatedListPtr(const DtRwTemplatedListPtr<T, T_autoDelete>& orig, 
                                              DtReaderWriterRegistry * parentRegistry) :
DtRwList(orig.name(), orig, parentRegistry),
myAutoDelete(orig.myAutoDelete)
{
   copyList(orig);
}

template <typename T, bool T_autoDelete>
DtRwTemplatedListPtr<T, T_autoDelete>::~DtRwTemplatedListPtr()
{
   if (myAutoDelete)
   {
      removeAndDeleteAll();
   }
}

template <typename T, bool T_autoDelete>
DtRwTemplatedListPtr<T, T_autoDelete>& DtRwTemplatedListPtr<T, T_autoDelete>::operator=(const DtRwTemplatedListPtr<T, T_autoDelete>& orig)
{
   if (this != &orig)
   {
      DtRwList::operator=(orig);

      removeAll();
      copyList(orig);
      myAutoDelete = orig.myAutoDelete;
   }

   return *this;
}

template <typename T, bool T_autoDelete>
void * DtRwTemplatedListPtr<T, T_autoDelete>::remove(T* item)
{
   DtListItem* listItem = itemLookup(item);

   if (listItem)
   {
      return remove(listItem);
   }

   return NULL;
}

template <typename T, bool T_autoDelete>
void* DtRwTemplatedListPtr<T, T_autoDelete>::remove(DtListItem* item)
{
   T* d = (T*)DtRwList::remove(static_cast<DtReaderWriter*>(item->data()), item);
   if (myAutoDelete)
   {
      delete d;
      d = NULL;
      return NULL;
   }
   else
   {
      return d;
   }
}

template <typename T, bool T_autoDelete>
void DtRwTemplatedListPtr<T, T_autoDelete>::removeAndDeleteAll()
{
   std::vector<T*> toDelete;

   iterator iter(*this);

   for (T* info = iter.first(); info; info = iter.next())
   {
      toDelete.push_back(info);
   }

   DtRwList::removeAll();

   int iLimit = toDelete.size();

   for (int i = 0; i < iLimit; i++)
   {
      delete toDelete[i];
   }
}

template <typename T, bool T_autoDelete>
DtlObjPtr DtRwTemplatedListPtr<T, T_autoDelete>::getData(DtlObjPtr args, const DtFilename& searchPath,
                                           const DtVariableBindingsList& variableBindings)
{
   DtlObjPtr nameObj = DtcCar(args);
   DtlObjPtr nextItem = DtcCdr(args);
   if(nextItem == DtlObjPtr::nil())
   {
      return nextItem;
   }

   T* value = new T(nameObj->pname());
   value->getSelf(args, searchPath, variableBindings);

   add(value);

   return DtcCdr(DtcCdr(args));
}

template <typename T, bool T_autoDelete>
void DtRwTemplatedListPtr<T, T_autoDelete>::removeAll()
{
   if (myAutoDelete)
   {
      removeAndDeleteAll();
   }
   else
   {
      DtRwList::removeAll();
   }
}

template <typename T, bool T_autoDelete>
void DtRwTemplatedListPtr<T, T_autoDelete>::copyList(const DtRwTemplatedListPtr<T, T_autoDelete>& orig)
{
   iterator iter(orig);

   for (T* info = iter.first(); info; info = iter.next())
   {
      add(new T(*info));
   }
}

template <typename T, bool T_autoDelete>
const char* DtRwTemplatedListPtr<T, T_autoDelete>::readerWriterType() const
{
   return ListReaderWriterType();
};

template <typename T, bool T_autoDelete>
const char* DtRwTemplatedListPtr<T, T_autoDelete>::ListReaderWriterType()
{
   static T theDefaultType("default-name");
   static std::string* listType = new std::string(
      std::string(theDefaultType.readerWriterType()) + "-templated-list");
   return listType->c_str();
}

template <typename T, bool T_autoDelete>
bool DtRwTemplatedListPtr<T, T_autoDelete>::operator==(const DtRwTemplatedListPtr& rhs) const
{
   if (count() == rhs.count())
   {
      DtListItem* thisItem = first();
      DtListItem* thatItem = rhs.first();

      while (thisItem && thatItem)
      {
         T* thisElement = static_cast<T*>(thisItem->data());
         T* thatElement = static_cast<T*>(thatItem->data());

         if (*thisElement != *thatElement)
         {
            return false;
         }

         thisItem = thisItem->next();
         thatItem = thatItem->next();
      }

      return true;
   }

   return false;
}

template <typename T, bool T_autoDelete>
bool DtRwTemplatedListPtr<T, T_autoDelete>::operator!=(const DtRwTemplatedListPtr& rhs) const
{
   return !(*this == rhs);
}

namespace DtBufferSerialize
{
   template <typename T, bool T_autoDelete>
   int getSize(const DtRwTemplatedListPtr<T, T_autoDelete>& val)
   {
      DtU16 a;
      int size = getSize(a);
      DtListItem* item = val.first();
      while(item)
      {
         const T* itemValue = static_cast<const T*>(item->data());
         size += getSize(*itemValue);
         item = item->next();
      }
      return size;
   }

   template <typename T, bool T_autoDelete>
   char *encode(const DtRwTemplatedListPtr<T, T_autoDelete>& val, char *buffer)
   {
      DtU16 n = val.count();
      buffer = encode(n, buffer);
      DtListItem* item = val.first();
      while(item)
      {
         const T* itemValue = static_cast<const T*>(item->data());
         buffer = encode(*itemValue, buffer);
         item = item->next();
      }
      return buffer;
   }

   template <typename T, bool T_autoDelete>
   const char *decode(DtRwTemplatedListPtr<T, T_autoDelete>& val, const char *buffer) 
   {
      DtU16 n = 0;
      buffer = decode(n, buffer);
      val.removeAndDeleteAll();
      for(int i = 0; i < n;++i)
      {
         T* itemValue = new T("item", &(val.registry()));
         buffer = decode(*itemValue, buffer);
         val.addToEnd(itemValue);
      }
      return buffer;
   }
};