singletonlist.hh

Go to the documentation of this file.

#ifndef DUNE_FEM_SINGLETONLIST_HH
#define DUNE_FEM_SINGLETONLIST_HH
 
//- System includes
#include <cassert>
#include <vector>
#include <string>
#include <list>
#include <iostream>
#include <type_traits>
#include <utility>
 
//- dune-fem includes
#include <dune/fem/misc/mpimanager.hh>
#include <dune/fem/storage/singleton.hh>
 
namespace Dune
{
 
  namespace Fem
  {
 
    template< class Key, class Object >
    struct DefaultSingletonFactory
    {
      static Object *createObject ( const Key &key )
      {
        return new Object( key );
      }
 
      static void deleteObject ( Object *object )
      {
        delete object;
      }
    };
 
 
    template< class Key, class Object,
              class Factory = DefaultSingletonFactory< Key, Object > >
    class SingletonList
    {
      typedef SingletonList< Key, Object, Factory > ThisType;
 
    public:
      typedef Key KeyType;
      typedef Object ObjectType;
      typedef Factory FactoryType;
 
      typedef std :: pair< ObjectType * , unsigned int * > ValueType;
      typedef std :: pair< KeyType, ValueType > ListObjType;
 
      struct Deleter
      {
        void operator() ( ObjectType *p ) const { ThisType::removeObject( *p ); }
      };
 
    private:
      typedef std :: list< ListObjType > ListType;
      typedef typename ListType :: iterator ListIteratorType;
 
      class SingletonListStorage;
 
    public:
      SingletonList () = delete;
      SingletonList ( const ThisType& ) = delete;
 
      static ListType &singletonList ()
      {
        //static SingletonListStorage s;
        SingletonListStorage& s = Singleton< SingletonListStorage >::instance();
 
        return s.singletonList();
      }
 
      template< class... Args >
      static auto getObject( const KeyType &key, Args &&... args )
        -> std::enable_if_t< std::is_same< decltype( FactoryType::createObject( key, std::forward< Args >( args )... ) ), ObjectType * >::value, ObjectType & >
      {
        ValueType objValue = getObjFromList( key );
 
        // if object exists, increase reference count and return it
        if( objValue.first )
        {
          ++( *(objValue.second) );
          return *(objValue.first);
        }
 
        // make sure this part is only called in single thread mode
        if( ! Fem :: MPIManager :: singleThreadMode() )
        {
          DUNE_THROW(SingleThreadModeError, "SingletonList::getObject: only call in single thread mode!");
        }
 
        // object does not exist. Create it with reference count of 1
        ObjectType *object = FactoryType::createObject( key, std::forward< Args >( args )... );
        assert( object );
        ValueType value( object, new unsigned int( 1 ) );
        ListObjType tmp( key, value );
        singletonList().push_back( tmp );
        return *object;
      }
 
      inline static void removeObject ( const ObjectType &object )
      {
        // make sure this method is only called in single thread mode
        if( ! Fem :: MPIManager :: singleThreadMode() )
        {
          DUNE_THROW(SingleThreadModeError, "SingletonList::removeObject: only call in single thread mode!");
        }
 
        ListIteratorType end = singletonList().end();
        for( ListIteratorType it = singletonList().begin(); it != end; ++it )
        {
          if( (*it).second.first == &object )
          {
            eraseItem( it );
            return;
          }
        }
 
        std :: cerr << "Object could not be deleted, "
                    << "because it is not in the list anymore!" << std :: endl;
      }
 
      // return pair < Object * , refCounter *>
      inline static ValueType getObjFromList( const KeyType &key )
      {
        ListIteratorType endit = singletonList().end();
        for(ListIteratorType it = singletonList().begin(); it!=endit; ++it)
        {
          if( (*it).first == key )
          {
            return (*it).second;
          }
        }
        return ValueType( (ObjectType *)0, (unsigned int *)0 );
      }
 
    protected:
      static void eraseItem( ListIteratorType &it )
      {
        ValueType value = (*it).second;
        unsigned int &refCount = *(value.second);
 
        assert( refCount > 0 );
        if( (--refCount) == 0 )
          deleteItem( it );
      }
 
    private:
      static void deleteItem(ListIteratorType & it)
      {
        ValueType val = (*it).second;
        // remove from list
        singletonList().erase( it );
        // delete objects
        FactoryType :: deleteObject( val.first );
        delete val.second;
      }
    }; // end SingletonList
 
 
    template< class Key, class Object, class Factory >
    class SingletonList< Key, Object, Factory > :: SingletonListStorage
    {
      typedef SingletonListStorage ThisType;
 
    protected:
      ListType singletonList_;
 
    public:
      inline SingletonListStorage ()
      : singletonList_()
      {}
 
      inline ~SingletonListStorage ()
      {
        while( !singletonList().empty() )
          deleteItem( singletonList().begin() );
      }
 
      ListType &singletonList ()
      {
        return singletonList_;
      }
 
      void deleteItem ( const ListIteratorType &it )
      {
        ValueType val = (*it).second;
        // remove from list
        singletonList().erase( it );
        // delete objects
        FactoryType :: deleteObject( val.first );
        delete val.second;
      }
    };
 
  } // namespace Fem
 
} // namespace Dune
 
#endif //  #ifndef DUNE_FEM_SINGLETONLIST_HH