MainFactory.h

Go to the documentation of this file.

// Copyright 2002-2019 CEA LIST
// SPDX-FileCopyrightText: 2022 CEA LIST <gael.de-chalendar@cea.fr>
//
// SPDX-License-Identifier: MIT
 
/***************************************************************************
 *   Copyright (C) 2004-2019 by CEA LIST                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef LIMA_COMMON_ABSTRACTFACTORYPATTERN_MAINFACTORY_H
#define LIMA_COMMON_ABSTRACTFACTORYPATTERN_MAINFACTORY_H
 
#include "common/AbstractFactoryPattern/AbstractFactoryPatternExport.h"
#include "common/XMLConfigurationFiles/groupConfigurationStructure.h"
#include "common/XMLConfigurationFiles/xmlConfigurationFileExceptions.h"
 
#include <map>
#include <deque>
#include <string>
#include <typeinfo>
 
#include "MainFactoriesMap.h"
 
namespace Lima
{
 
  template<typename Factory>
  class MainFactory
  {
 
  public:
 
    static const MainFactory<Factory>& single();
 
    static MainFactory<Factory>& changeable();
 
    static void cleanup();
 
    const std::shared_ptr<Factory> getFactory(const std::string& classId) const;
 
    std::shared_ptr<Factory> getFactory(const std::string& classId);
 
    void registerFactory(
      const std::string& classId,
      Factory* fact);
 
    std::deque<std::string> getRegisteredFactories() const;
 
    virtual ~MainFactory();
 
  private:
 
    MainFactory();
 
    typedef std::map<std::string, std::shared_ptr<Factory>> FactoryMap;
    typedef typename FactoryMap::const_iterator FactoryMapCItr;
    FactoryMap m_factories;
 
  };
 
  template<typename Factory>
  MainFactory<Factory>::MainFactory() : m_factories() {}
 
  template<typename Factory>
  const MainFactory<Factory>& MainFactory<Factory>::single()
  {
    typename MainFactoryMap::const_iterator it = MainFactoriesMap::get().find(typeid(Factory).name());
    if (MainFactoriesMap::get().end() == it)
      MainFactoriesMap::get().insert(std::pair<std::string, void*>(typeid(Factory).name(), new MainFactory<Factory>()));
 
    it = MainFactoriesMap::get().find(typeid(Factory).name());
    if (MainFactoriesMap::get().end() == it)
      throw LimaException("This can't happen.");
 
    return *((const MainFactory<Factory>*)(it->second));
  }
 
  template<typename Factory>
  MainFactory<Factory>& MainFactory<Factory>::changeable()
  {
    typename MainFactoryMap::iterator it = MainFactoriesMap::get().find(typeid(Factory).name());
    if (MainFactoriesMap::get().end() == it)
      MainFactoriesMap::get().insert(std::pair<std::string, void*>(typeid(Factory).name(), new MainFactory<Factory>()));
 
    it = MainFactoriesMap::get().find(typeid(Factory).name());
    if (MainFactoriesMap::get().end() == it)
      throw LimaException("This can't happen.");
 
    return *((MainFactory<Factory>*)(it->second));
  }
 
 
  template<typename Factory>
  void MainFactory<Factory>::cleanup()
  {
  }
 
  template<typename Factory>
  MainFactory<Factory>::~MainFactory()
  {
  }
 
  template<typename Factory>
  const std::shared_ptr<Factory> MainFactory<Factory>::getFactory(const std::string& classId) const
  {
    if (classId.empty())
    {
      std::cerr << "Trying to access to factory with empty name!" << std::endl;
      throw InvalidConfiguration("Trying to access to factory with empty name!");
    }
    FactoryMapCItr factItr=m_factories.find(classId);
    if (factItr==m_factories.end())
    {
      std::cerr << "1: No AbstractFactory for classId '" << classId << "' ! " << std::endl;
      std::cerr << "   Should be initialized at library loading time." << std::endl;
      std::cerr << "   Maybe you forgot to link with the library defining this classId ?" << std::endl;
      std::cerr << "   Or you forgot to define it as a plugin using, in its CMakeLists.txt," << std::endl;
      std::cerr << "   DECLARE_LIMA_PLUGIN, instead of add_library ?" << std::endl;
      throw InvalidConfiguration(
        QString::fromStdString("No AbstractFactory for classId '%1'").arg(
          QString::fromStdString(classId)));
    }
    return factItr->second;
  }
 
  template<typename Factory>
  std::shared_ptr<Factory> MainFactory<Factory>::getFactory(const std::string& classId)
  {
    if (classId.empty())
    {
      std::cerr << "Trying to access to factory with empty name!" << std::endl;
      throw InvalidConfiguration("Trying to access to factory with empty name!");
    }
    FactoryMapCItr factItr=m_factories.find(classId);
    if (factItr==m_factories.end())
    {
      std::cerr << "2: No AbstractFactory for classId '" << classId << "' ! " << std::endl;
      std::cerr << "   Should be initialized at library loading time." << std::endl;
      std::cerr << "   Maybe you forgot to link with the library defining this classId ?" << std::endl;
      std::cerr << "   Or you forgot to define it as a plugin using, in its CMakeLists.txt," << std::endl;
      std::cerr << "   DECLARE_LIMA_PLUGIN, instead of add_library ?" << std::endl;
      throw InvalidConfiguration(
        QString::fromStdString("No AbstractFactory for classId '%1'").arg(
          QString::fromStdString(classId)));
    }
    return factItr->second;
  }
 
  template<typename Factory>
  void MainFactory<Factory>::registerFactory(
    const std::string& classId,
    Factory* fact)
  {
    // std::cerr << "register factory for classId '" << classId << "'" << std::endl;
    if (m_factories.find(classId)!=m_factories.end())
    {
      std::cerr << "Factory for classId '" << classId << "' already exists do not replace it." << std::endl;
      // throw InvalidConfiguration();
    }
    else
    {
      m_factories[classId]= std::shared_ptr<Factory>(fact);
    }
  }
 
  template<typename Factory>
  std::deque<std::string> MainFactory<Factory>::getRegisteredFactories() const
  {
    std::deque<std::string> result;
    for (FactoryMapCItr factItr=m_factories.begin();
         factItr!=m_factories.end();
         factItr++)
         {
           result.push_back(factItr->first);
         }
         return result;
  }
 
} // Lima
 
#endif