ModuleManager.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/core/FrameworkExceptions.h>
 
#include <memory>
 
#include <string>
#include <map>
#include <list>
 
namespace boost {
  namespace filesystem {
    class directory_entry;
  }
}
 
namespace Belle2 {
  class Module;
  class ModuleProxyBase;
 
  class ModuleManager {
 
  public:
 
    //Define exceptions
    BELLE2_DEFINE_EXCEPTION(ModuleNotCreatedError, "Cannot create module %1%: %2%")
 
    
    static ModuleManager& Instance();
 
    void registerModuleProxy(ModuleProxyBase* moduleProxy);
 
    void addModuleSearchPath(const std::string& path);
 
    const std::list<std::string>& getModuleSearchPaths() const;
 
    const std::map<std::string, std::string>& getAvailableModules() const;
 
    std::shared_ptr<Module> registerModule(const std::string& moduleName,
                                           std::string sharedLibPath = "") noexcept(false);
 
    const std::list< std::shared_ptr<Module> >& getCreatedModules() const;
 
    static std::list< std::shared_ptr<Module> > getModulesByProperties(const std::list< std::shared_ptr<Module> >& modulePathList,
        unsigned int propertyFlags);
 
    static bool allModulesHaveFlag(const std::list<std::shared_ptr<Module>>& list, unsigned int flag);
 
    void reset();
 
 
  private:
    std::list<std::string> m_moduleSearchPathList;
 
    std::map<std::string, std::string> m_moduleNameLibMap;
 
    std::map<std::string, ModuleProxyBase*> m_registeredProxyMap; 
    std::list< std::shared_ptr<Module> > m_createdModulesList;  
    static void fillModuleNameLibMap(std::map<std::string, std::string>& moduleNameLibMap,
                                     const boost::filesystem::directory_entry& mapPath);
 
    ModuleManager();
 
    ModuleManager(const ModuleManager&);
 
    ModuleManager& operator=(const ModuleManager&);
 
    ~ModuleManager();
  };
 
} //end of namespace Belle2