Move FileRegistry to singleton Refs #7263

It appears that we can't start the FrameworkManager during static
initialization or the destruction of the FrameworkManager instance gets
instance gets confused.

Code/Mantid/Framework/API/CMakeLists.txt

@@ -286,7 +286,6 @@ set ( TEST_FILES
 	ExpressionTest.h
 	FermiChopperModelTest.h
 	FileFinderTest.h
-	FileLoaderRegistryTest.h
 	FilePropertyTest.h
 	FrameworkManagerTest.h
 	FuncMinimizerFactoryTest.h

Code/Mantid/Framework/API/inc/MantidAPI/FileLoaderRegistry.h

@@ -3,6 +3,7 @@
 
 #include "MantidAPI/DllConfig.h"
 #include "MantidAPI/AlgorithmFactory.h"
+#include "MantidKernel/SingletonHolder.h"
 
 #include <set>
 #include <string>
@@ -20,7 +21,7 @@ namespace Mantid
 
     /**
     Keeps a registry of algorithm's that are file loading algorithms to allow them to be searched
-    to find the correct one to load a particular file. Uses FileLoaderPicker to do the most of the work
+    to find the correct one to load a particular file.
 
     A macro, DECLARE_FILELOADER_ALGORITHM is defined in RegisterFileLoader.h. Use this in place of the standard
     DECLARE_ALGORITHM macro
@@ -45,17 +46,14 @@ namespace Mantid
     File change history is stored at: <https://github.com/mantidproject/mantid>
     Code Documentation is available at: <http://doxygen.mantidproject.org>
      */
-    class MANTID_API_DLL FileLoaderRegistry
+    class MANTID_API_DLL FileLoaderRegistryImpl
     {
     public:
 
       /// Defines types of possible file
       enum LoaderFormat { NonHDF, HDF };
 
     public:
-      /// Default constructor
-      FileLoaderRegistry();
-
       /// @returns the number of entries in the registry
       inline size_t size() const { return m_totalSize; }
 
@@ -81,6 +79,14 @@ namespace Mantid
       const std::string chooseLoader(const std::string &filename) const;
 
     private:
+      /// Friend so that CreateUsingNew
+      friend struct Mantid::Kernel::CreateUsingNew<FileLoaderRegistryImpl>;
+
+      /// Default constructor (for singleton)
+      FileLoaderRegistryImpl();
+      /// Destructor
+      ~FileLoaderRegistryImpl();
+
       /// The list of names. The index pointed to by LoaderFormat defines a set for that format
       std::vector<std::set<std::string> > m_names;
       /// Total number of names registered
@@ -90,6 +96,15 @@ namespace Mantid
       Kernel::Logger & m_log;
     };
 
+    ///Forward declaration of a specialisation of SingletonHolder for FileLoaderRegistryImpl (needed for dllexport/dllimport) and a typedef for it.
+    #ifdef _WIN32
+      // this breaks new namespace declaration rules; need to find a better fix
+      template class MANTID_API_DLL Mantid::Kernel::SingletonHolder<FileLoaderRegistryImpl>;
+    #endif /* _WIN32 */
+
+    /// Type for the actual singleton instance
+    typedef MANTID_API_DLL Mantid::Kernel::SingletonHolder<FileLoaderRegistryImpl> FileLoaderRegistry;
+
   } // namespace API
 } // namespace Mantid
 

Code/Mantid/Framework/API/inc/MantidAPI/FrameworkManager.h

@@ -90,11 +90,6 @@ namespace Mantid
       /// Creates an algorithm and runs it, with variadic arguments
       boost::shared_ptr<IAlgorithm> exec(const std::string& algorithmName, int count, ...);
 
-      /// Returns a const version of the main registry of file loader algorithms
-      inline const FileLoaderRegistry & fileLoaderRegistry() const { return m_fileLoaderRegistry; }
-      /// Returns a non-const version of the main registry of file loader algorithms
-      inline FileLoaderRegistry & fileLoaderRegistry() { return m_fileLoaderRegistry; }
-
       /// Returns a shared pointer to the workspace requested
       Workspace* getWorkspace(const std::string& wsName);
 
@@ -122,8 +117,6 @@ namespace Mantid
       /// Silence NeXus output
       void disableNexusOutput();
 
-      /// The registry of FileLoader algorithms
-      FileLoaderRegistry m_fileLoaderRegistry;
       /// Reference to the logger class
       Kernel::Logger& g_log;
 

Code/Mantid/Framework/API/inc/MantidAPI/RegisterFileLoader.h

@@ -1,8 +1,7 @@
 #ifndef MANTID_API_REGISTERFILELOADER_H_
 #define MANTID_API_REGISTERFILELOADER_H_
 
-#include "MantidAPI/AlgorithmFactory.h"
-#include "MantidAPI/FrameworkManager.h"
+#include "MantidAPI/FileLoaderRegistry.h"
 
 /**
  * DECLARE_FILELOADER_ALGORITHM should be used in place of the standard
@@ -16,7 +15,7 @@
   {\
     Mantid::Kernel::RegistrationHelper \
       reg_loader_##classname((Mantid::API::\
-        FrameworkManager::Instance().fileLoaderRegistry().subscribe<classname>(Mantid::API::FileLoaderRegistry::NonHDF), 0));\
+        FileLoaderRegistry::Instance().subscribe<classname>(Mantid::API::FileLoaderRegistryImpl::NonHDF), 0));\
   }
 
 /**
@@ -31,7 +30,7 @@
   {\
     Mantid::Kernel::RegistrationHelper \
       reg_hdf_loader_##classname((Mantid::API::\
-        FrameworkManager::Instance().fileLoaderRegistry().subscribe<classname>(Mantid::API::FileLoaderRegistry::HDF), 0)); \
+        FileLoaderRegistry::Instance().subscribe<classname>(Mantid::API::FileLoaderRegistryImpl::HDF), 0)); \
   }
 
 

Code/Mantid/Framework/API/src/FileLoaderRegistry.cpp

@@ -73,14 +73,6 @@ namespace Mantid
     //----------------------------------------------------------------------------------------------
     // Public members
     //----------------------------------------------------------------------------------------------
-    /**
-     * Creates an empty registry
-     */
-    FileLoaderRegistry::FileLoaderRegistry() :
-        m_names(2, std::set<std::string>()), m_totalSize(0),
-        m_log(Kernel::Logger::get("FileLoaderRegistry"))
-    {
-    }
 
     /**
      * Queries each registered algorithm and asks it how confident it is that it can
@@ -89,7 +81,7 @@ namespace Mantid
      * @return A string containing the name of an algorithm to load the file
      * @throws Exception::NotFoundError if an algorithm cannot be found
      */
-    const std::string FileLoaderRegistry::chooseLoader(const std::string &filename) const
+    const std::string FileLoaderRegistryImpl::chooseLoader(const std::string &filename) const
     {
       using Kernel::FileDescriptor;
       using Kernel::HDFDescriptor;
@@ -122,6 +114,20 @@ namespace Mantid
     //----------------------------------------------------------------------------------------------
     // Private members
     //----------------------------------------------------------------------------------------------
+    /**
+     * Creates an empty registry
+     */
+    FileLoaderRegistryImpl::FileLoaderRegistryImpl() :
+        m_names(2, std::set<std::string>()), m_totalSize(0),
+        m_log(Kernel::Logger::get("FileLoaderRegistry"))
+    {
+    }
+
+    /**
+     */
+    FileLoaderRegistryImpl::~FileLoaderRegistryImpl()
+    {
+    }
 
   } // namespace API
 } // namespace Mantid

Code/Mantid/Framework/API/src/FrameworkManager.cpp

@@ -42,8 +42,7 @@ namespace API
 
 
 /// Default constructor
-FrameworkManagerImpl::FrameworkManagerImpl()
-  : m_fileLoaderRegistry(), g_log(Kernel::Logger::get("FrameworkManager"))
+FrameworkManagerImpl::FrameworkManagerImpl() : g_log(Kernel::Logger::get("FrameworkManager"))
 #ifdef MPI_BUILD
       , m_mpi_environment()
 #endif