#5200: Change the IApplicationContext::getLibraryPaths() interface to…

… return a collection of paths.
codereader · Aug 30, 2020 · 48d2d05 · 48d2d05
1 parent 18061fe
commit 48d2d05
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 20 deletions.
diff --git a/include/imodule.h b/include/imodule.h
@@ -72,13 +72,14 @@ class IApplicationContext
 	virtual std::string getApplicationPath() const = 0;
 
     /**
-     * Return the application library path, containing modules and plugins.
+     * Return the application library paths, each of these is searched
+	 * for any libraries containing modules and/or plugins.
      *
      * On Windows this is most likely the same as the application path. On
      * Linux it might be a hard-coded path like /usr/lib/darkradiant, or a
      * relocatable relative path like ../lib
      */
-    virtual std::string getLibraryPath() const = 0;
+    virtual std::vector<std::string> getLibraryPaths() const = 0;
 
     /**
      * Return the toplevel path contaning runtime data files, such as the GL

diff --git a/libs/module/ApplicationContextBase.cpp b/libs/module/ApplicationContextBase.cpp
@@ -26,19 +26,23 @@ std::string ApplicationContextBase::getApplicationPath() const
 	return _appPath;
 }
 
-std::string ApplicationContextBase::getLibraryPath() const
+std::vector<std::string> ApplicationContextBase::getLibraryPaths() const
 {
+	std::vector<std::string> libPaths;
+
 #if defined(__APPLE__)
-    return _appPath;
+	libPaths.push_back(_appPath);
 #elif defined(POSIX)
 #   if defined(PKGLIBDIR) && !defined(ENABLE_RELOCATION)
-    return PKGLIBDIR;
+	libPaths.push_back(PKGLIBDIR);
 #   else
-    return _appPath + "../lib/darkradiant/";
+	libPaths.push_back(_appPath + "../lib/darkradiant/");
 #   endif
 #else // !defined(POSIX)
-    return _appPath;
+	libPaths.push_back(_appPath);
 #endif
+
+	return libPaths;
 }
 
 std::string ApplicationContextBase::getRuntimeDataPath() const

diff --git a/libs/module/ApplicationContextBase.h b/libs/module/ApplicationContextBase.h
@@ -33,7 +33,7 @@ class ApplicationContextBase :
 
     /* ApplicationContext implementation */
     virtual std::string getApplicationPath() const override;
-    virtual std::string getLibraryPath() const override;
+    virtual std::vector<std::string> getLibraryPaths() const override;
     virtual std::string getRuntimeDataPath() const override;
     virtual std::string getHTMLPath() const override;
     virtual std::string getSettingsPath() const override;

diff --git a/libs/module/CoreModule.cpp b/libs/module/CoreModule.cpp
@@ -1,6 +1,7 @@
 #include "CoreModule.h"
 
 #include "DynamicLibrary.h"
+#include "string/join.h"
 
 // In Linux the CORE_MODULE_LIBRARY symbol is defined in config.h
 #ifdef HAVE_CONFIG_H
@@ -15,17 +16,9 @@ namespace module
 CoreModule::CoreModule(IApplicationContext& context) :
 	_instance(nullptr)
 {
-	std::string coreModuleFile = std::string(CORE_MODULE_LIBRARY) + MODULE_FILE_EXTENSION;
-
-	fs::path coreModulePath = context.getLibraryPath();
-	coreModulePath /= coreModuleFile;
-
-	if (!fs::exists(coreModulePath))
-	{
-		throw FailureException("Cannot find the main module " + coreModulePath.string());
-	}
-
-	_coreModuleLibrary.reset(new DynamicLibrary(coreModulePath.string()));
+	auto coreModulePath = findCoreModule(context);
+
+	_coreModuleLibrary.reset(new DynamicLibrary(coreModulePath));
 
 	if (_coreModuleLibrary->failed())
 	{
@@ -50,6 +43,26 @@ CoreModule::~CoreModule()
 	destroy();
 }
 
+std::string CoreModule::findCoreModule(IApplicationContext& context)
+{
+	std::string coreModuleFile = std::string(CORE_MODULE_LIBRARY) + MODULE_FILE_EXTENSION;
+	auto libraryPaths = context.getLibraryPaths();
+
+	for (auto libPath : libraryPaths)
+	{
+		fs::path coreModulePath = libPath;
+		coreModulePath /= coreModuleFile;
+
+		if (fs::exists(coreModulePath))
+		{
+			return coreModulePath.string();
+		}
+	}
+
+	throw FailureException("Cannot find the main module in any of the paths: " + 
+		string::join(libraryPaths, "; "));
+}
+
 radiant::IRadiant* CoreModule::get()
 {
 	return _instance;

diff --git a/libs/module/CoreModule.h b/libs/module/CoreModule.h
@@ -41,6 +41,7 @@ class CoreModule
 	radiant::IRadiant* get();
 
 private:
+	std::string findCoreModule(IApplicationContext& context);
 	void destroy();
 };
 

diff --git a/libs/module/DynamicLibrary.h b/libs/module/DynamicLibrary.h
@@ -21,6 +21,7 @@ const char* const MODULE_FILE_EXTENSION = ".so";
  */
 #if defined(WIN32)
 
+#define NOMINMAX
 #include <windows.h>
 
 namespace module

diff --git a/radiantcore/modulesystem/ModuleRegistry.cpp b/radiantcore/modulesystem/ModuleRegistry.cpp
@@ -162,7 +162,11 @@ void ModuleRegistry::loadAndInitialiseModules()
 	rMessage() << "ModuleRegistry Compatibility Level is " << getCompatibilityLevel() << std::endl;
 
 	// Invoke the ModuleLoad routine to load the DLLs from modules/ and plugins/
-	_loader->loadModules(_context.getLibraryPath());
+	auto libraryPaths = _context.getLibraryPaths();
+	for (auto path : libraryPaths)
+	{
+		_loader->loadModules(path);
+	}
 
 	_progress = 0.1f;
 	_sigModuleInitialisationProgress.emit(_("Initialising Modules"), _progress);