clone_factory.h

Go to the documentation of this file.

/*
 * *** ATTENTION!  DO NOT MODIFY THIS FILE DIRECTLY! ***
 * 
 * It has automatically been generated from clone_factory.tmpl.h
 * by param_expander.py on Sun Nov 09 16:55:52 2008.
 */

/** @file
 *  @author Bram de Greve (bramz@users.sourceforge.net)
 *  @author Tom De Muer (tomdemuer@users.sourceforge.net)
 *
 *  *** BEGIN LICENSE INFORMATION ***
 *  
 *  The contents of this file are subject to the Common Public Attribution License 
 *  Version 1.0 (the "License"); you may not use this file except in compliance with 
 *  the License. You may obtain a copy of the License at 
 *  http://lass.sourceforge.net/cpal-license. The License is based on the 
 *  Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover 
 *  use of software over a computer network and provide for limited attribution for 
 *  the Original Developer. In addition, Exhibit A has been modified to be consistent 
 *  with Exhibit B.
 *  
 *  Software distributed under the License is distributed on an "AS IS" basis, WITHOUT 
 *  WARRANTY OF ANY KIND, either express or implied. See the License for the specific 
 *  language governing rights and limitations under the License.
 *  
 *  The Original Code is LASS - Library of Assembled Shared Sources.
 *  
 *  The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
 *  The Original Developer is the Initial Developer.
 *  
 *  All portions of the code written by the Initial Developer are:
 *  Copyright (C) 2004-2007 the Initial Developer.
 *  All Rights Reserved.
 *  
 *  Contributor(s):
 *
 *  Alternatively, the contents of this file may be used under the terms of the 
 *  GNU General Public License Version 2 or later (the GPL), in which case the 
 *  provisions of GPL are applicable instead of those above.  If you wish to allow use
 *  of your version of this file only under the terms of the GPL and not to allow 
 *  others to use your version of this file under the CPAL, indicate your decision by 
 *  deleting the provisions above and replace them with the notice and other 
 *  provisions required by the GPL License. If you do not delete the provisions above,
 *  a recipient may use your version of this file under either the CPAL or the GPL.
 *  
 *  *** END LICENSE INFORMATION ***
 */



/** @class lass::util::CloneFactory
 *  @brief object creation by cloning prototypes
 *  @author Bram de Greve [Bramz]
 *
 *  A clone factory is much like an object factory (lass::util::ObjectFactory), except that it will
 *  clone existings object rather than creating new ones from the ground up using maker functions.
 *
 *  A clone factory creates objects of the same hierarchy, i.e. objects that have a common base
 *  class.  The base class is an @e abstract product and the derived classes are @e concrete
 *  products.  The factory let you decide what concrete product to create at @e runtime by
 *  using a specific @e identifier.  These identifiers can be integers or strings or any
 *  type you can use in a std::map.
 *
 *  Before you can create any products, you must @e subscribe @e prototypes and @e cloner methods
 *  to the factory.  A @e prototype is an object instance that will be cloned by the @e cloner
 *  function.  Together, a pair of a @e prototype and a @e cloner function provides the
 *  functionality of one @e maker function in the ObjectFactory.
 *
 *  Again, all this @a cloners must have the same signature and should return a pointer to the
 *  abstract product.  Their first argument will be a reference to the prototype being cloned.
 *  The following arguments will be filled by the @a iP1, @a iP2, @a iP3, ... that are provided to
 *  the make() method of the clone factory.
 *
 *  @code
 *  class Base
 *  {
 *  public:
 *      Base(const std::string& iName): name_(iName) {}
 *      virtual std::string who() const { return std::string("Base ") + name_; }
 *      virtual Base* clone() const { return new Base(*this); }
 *  protected:
 *      std::string name_;
 *  };
 *
 *  class Foo: public Base
 *  {
 *  public:
 *      Foo(const std::string& iName): Base(iName) {}
 *      virtual std::string who() const { return std::string("Foo ") + name_; }
 *      virtual Base* clone() const { return new Foo(*this); }
 *  };
 *
 *  class Bar: public Base
 *  {
 *  public:
 *      Bar(const std::string& iName): Base(iName) {}
 *      virtual std::string who() const { return std::string("Bar ") + name_; }
 *      virtual Base* clone() const { return new Bar(*this); }
 *  };
 *
 *  Base* clone(const Base& iPrototype) { return iPrototype.clone(); }
 *
  * typedef util::CloneFactory<Base, std::string> TFactory;
 *  typedef std::auto_ptr<Base> TBasePtr;
 *
 *  TFactory factory(clone);
 *  factory.subscribe("Joe", TBasePtr(new Base("Joe")));
 *  factory.subscribe("Moe", TBasePtr(new Foo("Moe")));
 *  factory.subscribe("Doe", TBasePtr(new Bar("Doe")));
 *
 *  TBasePtr a(factory.make("Joe"));
 *  LASS_COUT << a->who() << "\n"; // Base Joe
 *  TBasePtr b(factory.make("Moe"));
 *  LASS_COUT << b->who() << "\n"; // Foo Moe
 *  TBasePtr c(factory.make("Doe"));
 *  LASS_COUT << c->who() << "\n"; // Bar Doe
 *  @endcode
 */

#ifndef LASS_GUARDIAN_OF_INCLUSION_UTIL_CLONE_FACTORY_H
#define LASS_GUARDIAN_OF_INCLUSION_UTIL_CLONE_FACTORY_H

#include "util_common.h"
#include "shared_ptr.h"

namespace lass
{
namespace util
{

template
<
    class AbstractProduct,
    class IdentifierType,
    class ProductCloner = AbstractProduct*(*)(const AbstractProduct&)
>
class CloneFactory
{
public:

    typedef AbstractProduct TAbstractProduct;
    typedef IdentifierType TIdentifier;
    typedef ProductCloner TProductCloner;

    /** create a clone factory by specifying its cloner function @a iCloner.
     */
    CloneFactory(typename CallTraits<ProductCloner>::TParam iCloner):
        cloner_(iCloner)
    {
    }

    /** register a concrete product to the CloneFactory by a @a iIdentifier that will identify
     *  the product, and an @a iPrototype that will be cloned.
     */
    bool subscribe(typename CallTraits<IdentifierType>::TParam iIdentifier,
                   std::auto_ptr<AbstractProduct> iPrototype)
    {
        return prototypes_.insert(typename TPrototypes::value_type(iIdentifier, iPrototype)).second;
    }

    /** unregister a concrete product by its @a iIdentifier
     */
    bool unsubscribe(typename CallTraits<IdentifierType>::TParam iIdentifier)
    {
        return prototypes_.erase(iIdentifier) == 1;
    }

    /** Create a new concrete product by cloning the prototype
     *  only to be used if maker don't want any parameters.
     */
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second);
    }
    
    /** create a new concrete product by cloning the prototype with 1 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1);
    }
    
    /** create a new concrete product by cloning the prototype with 2 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2);
    }
    
    /** create a new concrete product by cloning the prototype with 3 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3);
    }
    
    /** create a new concrete product by cloning the prototype with 4 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4);
    }
    
    /** create a new concrete product by cloning the prototype with 5 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5);
    }
    
    /** create a new concrete product by cloning the prototype with 6 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6);
    }
    
    /** create a new concrete product by cloning the prototype with 7 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7);
    }
    
    /** create a new concrete product by cloning the prototype with 8 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7, typename P8>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7, P8& iP8) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7, iP8);
    }
    
    /** create a new concrete product by cloning the prototype with 9 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7, typename P8, typename P9>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7, P8& iP8, P9& iP9) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7, iP8, iP9);
    }
    
    /** create a new concrete product by cloning the prototype with 10 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7, typename P8, typename P9, typename P10>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7, P8& iP8, P9& iP9, P10& iP10) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7, iP8, iP9, iP10);
    }
    
    /** create a new concrete product by cloning the prototype with 11 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7, typename P8, typename P9, typename P10, typename P11>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7, P8& iP8, P9& iP9, P10& iP10, P11& iP11) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7, iP8, iP9, iP10, iP11);
    }
    
    /** create a new concrete product by cloning the prototype with 12 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7, typename P8, typename P9, typename P10, typename P11, typename P12>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7, P8& iP8, P9& iP9, P10& iP10, P11& iP11, P12& iP12) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7, iP8, iP9, iP10, iP11, iP12);
    }
    
    /** create a new concrete product by cloning the prototype with 13 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7, typename P8, typename P9, typename P10, typename P11, typename P12, typename P13>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7, P8& iP8, P9& iP9, P10& iP10, P11& iP11, P12& iP12, P13& iP13) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7, iP8, iP9, iP10, iP11, iP12, iP13);
    }
    
    /** create a new concrete product by cloning the prototype with 14 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7, typename P8, typename P9, typename P10, typename P11, typename P12, typename P13, typename P14>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7, P8& iP8, P9& iP9, P10& iP10, P11& iP11, P12& iP12, P13& iP13, P14& iP14) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7, iP8, iP9, iP10, iP11, iP12, iP13, iP14);
    }
    
    /** create a new concrete product by cloning the prototype with 15 additional parameter(s).
     *  only to be used if it can be mapped on @a iCloner function.
     */
    template <typename P1, typename P2, typename P3, typename P4, typename P5, typename P6, typename P7, typename P8, typename P9, typename P10, typename P11, typename P12, typename P13, typename P14, typename P15>
    AbstractProduct* make(typename CallTraits<IdentifierType>::TParam iIdentifier,
                          P1& iP1, P2& iP2, P3& iP3, P4& iP4, P5& iP5, P6& iP6, P7& iP7, P8& iP8, P9& iP9, P10& iP10, P11& iP11, P12& iP12, P13& iP13, P14& iP14, P15& iP15) const
    {
        typename TPrototypes::const_iterator i = prototypes_.find(iIdentifier);
        if (i == prototypes_.end())
        {
            LASS_THROW("Unknown Product identifier '" << iIdentifier
                << "' passed to CloneFactory.");
        }
        return cloner_(*i->second, iP1, iP2, iP3, iP4, iP5, iP6, iP7, iP8, iP9, iP10, iP11, iP12, iP13, iP14, iP15);
    }
    

private:

    typedef SharedPtr<AbstractProduct> TPrototypePtr;
    typedef std::map<IdentifierType, TPrototypePtr> TPrototypes;

    TPrototypes prototypes_;
    TProductCloner cloner_;
};



}

}

#endif

// EOF