pluggableFactory.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: pluggableFactory.h,v $ $Revision: 1.8 $ $State: Exp $
 *******************************************************************************/

#ifndef DtPluggableFactory_H_
#define DtPluggableFactory_H_

#include <iostream>
#include <vlutil/vlPrint.h>
#include <vlutil/vlSmartPointers.h>

template< typename BaseType, typename DerivedType >
class DtPluggableFactoryProduct;

#define DtREGISTER_WITH_FACTORY_BY_CLASSNAME( ProductClass, CreatableClass ) \
   static MAKRti::DtString DtRegistered##CreatableClass##With##ProductClass##FactoryByName = \
   DtPluggableFactory< MAKRti::DtString, ProductClass >::registerCreator( #CreatableClass, &CreatableClass::create );
#define DtREGISTER_WITH_FACTORY_BY_NAME( CreationKey, ProductClass, CreatableClass ) \
   static MAKRti::DtString DtRegistered##CreatableClass##With##ProductClass##FactoryByKey##CreationKey## = \
   DtPluggableFactory< MAKRti::DtString, ProductClass >::registerCreator( CreationKey, &CreatableClass::create );
#define DtREGISTER_TEMPLATE_WITH_FACTORY_BY_NAME( CreationKey, ProductClass, CreatableClass, TemplateParam ) \
   static MAKRti::DtString DtRegistered##CreatableClass##With##ProductClass##FactoryByKey##CreationKey## = \
   DtPluggableFactory< MAKRti::DtString, ProductClass >::registerCreator( CreationKey, &CreatableClass<TemplateParam>::create );

#define DtREGISTER_WITH_FACTORY_BY_CLASSNAME_WITH_PARAM( ProductClass, CreatableClass, CreatorParam ) \
   static MAKRti::DtString DtRegistered##CreatableClass##With##ProductClass##FactoryByNameWithParam = \
   DtPluggableFactory< MAKRti::DtString, ProductClass, CreatorParam >::registerCreator( #CreatableClass, &CreatableClass::create );
#define DtREGISTER_WITH_FACTORY_BY_NAME_WITH_PARAM( CreationKey, ProductClass, CreatableClass, CreatorParam ) \
   static MAKRti::DtString DtRegistered##CreatableClass##With##ProductClass##FactoryByKey##CreationKey##WithParam = \
   DtPluggableFactory< MAKRti::DtString, ProductClass, CreatorParam >::registerCreator( CreationKey, &CreatableClass::create );
#define DtREGISTER_TEMPLATE_WITH_FACTORY_BY_NAME_WITH_PARAM( CreationKey, ProductClass, CreatableClass, TemplateParam, CreatorParam ) \
   static MAKRti::DtString DtRegistered##CreatableClass##With##ProductClass##FactoryByKey##CreationKey##WithParam = \
   DtPluggableFactory< MAKRti::DtString, ProductClass, CreatorParam >::registerCreator( CreationKey, &CreatableClass<TemplateParam>::create );


template< typename Key, typename Product, typename ProductCreatorParameter >
class DtPluggableFactory
{
public:
   typedef DtBoost::shared_ptr<Product> DtFactoryProductSP;
   typedef DtFactoryProductSP (*DtCreatorFn)();
   typedef DtFactoryProductSP (*DtParamCreatorFn)(ProductCreatorParameter);

   typedef std::map< Key, DtCreatorFn > DtKeyToCreatorMap;
   typedef std::map< Key, DtParamCreatorFn > DtKeyToParamCreatorMap;

   static bool isCreatable( const Key& key );

   static DtFactoryProductSP create( const Key& key );

   static DtFactoryProductSP create( const Key& key, ProductCreatorParameter parameter);

   static MAKRti::DtString registerCreator( const Key& key, DtCreatorFn creator );

   static MAKRti::DtString registerCreator( const Key& key, DtParamCreatorFn creator );

private:

   DtPluggableFactory();

   static DtPluggableFactory< Key, Product, ProductCreatorParameter >* factory();
   
   bool productHasCreator( const Key& key );
   
   DtFactoryProductSP createProduct( const Key& key );
      
   DtFactoryProductSP createProduct( const Key& key, ProductCreatorParameter param );
      
   MAKRti::DtString registerProductCreator( const Key& key, DtCreatorFn creator );
      
   MAKRti::DtString registerProductCreator( const Key& key, DtParamCreatorFn creator );
      
private:

   DtKeyToCreatorMap theCreators;
   DtKeyToParamCreatorMap theParamCreators;
};


template< typename Key, typename Product, typename ProductCreatorParameter >
bool DtPluggableFactory<Key, Product, ProductCreatorParameter>::isCreatable( const Key& key )
{
   return factory()->productHasCreator( key );
}

template< typename Key, typename Product, typename ProductCreatorParameter >
typename DtPluggableFactory<Key, Product, ProductCreatorParameter>::DtFactoryProductSP DtPluggableFactory<Key, Product, ProductCreatorParameter>::create( const Key& key )
{
   return factory()->createProduct( key );
}

template< typename Key, typename Product, typename ProductCreatorParameter >
typename DtPluggableFactory<Key, Product, ProductCreatorParameter>::DtFactoryProductSP DtPluggableFactory<Key, Product, ProductCreatorParameter>::create( const Key& key, ProductCreatorParameter parameter)
{
   return factory()->createProduct( key, parameter );
}

template< typename Key, typename Product, typename ProductCreatorParameter >
MAKRti::DtString DtPluggableFactory<Key, Product, ProductCreatorParameter>::registerCreator( const Key& key, DtCreatorFn creator )
{
   return factory()->registerProductCreator( key, creator );
}

template< typename Key, typename Product, typename ProductCreatorParameter >
MAKRti::DtString DtPluggableFactory<Key, Product, ProductCreatorParameter>::registerCreator( const Key& key, DtParamCreatorFn creator )
{
   return factory()->registerProductCreator( key, creator );
}

template< typename Key, typename Product, typename ProductCreatorParameter >
DtPluggableFactory<Key, Product, ProductCreatorParameter>::DtPluggableFactory() {}

template< typename Key, typename Product, typename ProductCreatorParameter >
DtPluggableFactory< Key, Product, ProductCreatorParameter >* DtPluggableFactory<Key, Product, ProductCreatorParameter>::factory()
{
   static DtPluggableFactory< Key, Product, ProductCreatorParameter >* theFactory = 0;
   if ( !theFactory )
   {
      theFactory = new DtPluggableFactory< Key, Product, ProductCreatorParameter >();
   }
   return theFactory;
}
   
template< typename Key, typename Product, typename ProductCreatorParameter >
bool DtPluggableFactory<Key, Product, ProductCreatorParameter>::productHasCreator( const Key& key )
{
   return ( theCreators.find( key ) != theCreators.end() || 
            theParamCreators.find( key ) != theParamCreators.end() );
}
   
template< typename Key, typename Product, typename ProductCreatorParameter >
typename DtPluggableFactory<Key, Product, ProductCreatorParameter>::DtFactoryProductSP DtPluggableFactory<Key, Product, ProductCreatorParameter>::createProduct( const Key& key )
{
   typename DtKeyToCreatorMap::iterator pos = theCreators.find( key );
   if ( pos == theCreators.end() ) { return DtFactoryProductSP(); }
   return pos->second();
}
      
template< typename Key, typename Product, typename ProductCreatorParameter >
typename DtPluggableFactory<Key, Product, ProductCreatorParameter>::DtFactoryProductSP DtPluggableFactory<Key, Product, ProductCreatorParameter>::createProduct( const Key& key, ProductCreatorParameter param )
{
   typename DtKeyToParamCreatorMap::iterator pos = theParamCreators.find( key );
   if ( pos == theParamCreators.end() ) { return DtFactoryProductSP(); }
   return pos->second(param);
}
      
template< typename Key, typename Product, typename ProductCreatorParameter >
MAKRti::DtString DtPluggableFactory<Key, Product, ProductCreatorParameter>::registerProductCreator( const Key& key, DtCreatorFn creator )
{
#ifdef _DEBUG




   if ( productHasCreator( key ))
   {
      DtVerbose << "WARNING:  Attempted to register Factory Key: " << key << " for multiple creators this is often an error." << std::endl;
   }
#endif
      
   theCreators[ key ] = creator;
   return key;
}

      
template< typename Key, typename Product, typename ProductCreatorParameter >
MAKRti::DtString DtPluggableFactory<Key, Product, ProductCreatorParameter>::registerProductCreator( const Key& key, DtParamCreatorFn creator )
{
#ifdef _DEBUG




   if ( productHasCreator( key ))
   {
      MAKRti::DtVerbose << "WARNING:  Attempted to register Factory Key: " <<
         key << " for multiple creators this is often an error." << std::endl;
   }
#endif
      
   theParamCreators[ key ] = creator;
   return key;
}


#endif //! DtPluggableFactory_H_