#5108: Add ArchivedMapResource specialisation, which will load the ma…

…p from any PAK file. Add two virtual method to be overridden by the ArchivedMapResource
codereader · Nov 29, 2020 · d9f4dae · d9f4dae
1 parent 753549d
commit d9f4dae
Show file tree

Hide file tree

Showing 10 changed files with 96 additions and 34 deletions.
diff --git a/include/imapresource.h b/include/imapresource.h
@@ -83,9 +83,18 @@ class IMapResourceManager :
 {
 public:
 	/**
-	 * Load the named map resource from VFS or from a physical path.
+	 * Create a named map resource from VFS or from a physical path.
 	 */
-	virtual IMapResourcePtr loadFromPath(const std::string& path) = 0;
+	virtual IMapResourcePtr createFromPath(const std::string& path) = 0;
+
+    /**
+     * Create a named map resource that is contained within a PAK archive
+     * outside the VFS.
+     * archivePath is the absolute path to the archive file, e.g. "/home/greebo/outpost.pk4"
+     * filePathWithinArchive is the relative path within the archive, e.g. "maps/outpost.map"
+     */
+    virtual IMapResourcePtr createFromArchiveFile(const std::string& archivePath, 
+        const std::string& filePathWithinArchive) = 0;
 
 	// Signal emitted when a MapExport is starting / is finished
 	typedef sigc::signal<void, const scene::IMapRootNodePtr&> ExportEvent;

diff --git a/radiant/ui/prefabselector/PrefabSelector.cpp b/radiant/ui/prefabselector/PrefabSelector.cpp
@@ -402,7 +402,7 @@ void PrefabSelector::onSelectionChanged(wxutil::FileSystemView::SelectionChanged
 
     const auto& prefabPath = ev.GetSelectedPath();
 
-    _mapResource = GlobalMapResourceManager().loadFromPath(prefabPath);
+    _mapResource = GlobalMapResourceManager().createFromPath(prefabPath);
 
     if (!_mapResource)
     {

diff --git a/radiantcore/map/ArchivedMapResource.h b/radiantcore/map/ArchivedMapResource.h
@@ -0,0 +1,20 @@
+#pragma once
+
+#include "MapResource.h"
+
+namespace map
+{
+
+class ArchivedMapResource :
+    public MapResource
+{
+public:
+    ArchivedMapResource(const std::string& archivePath, const std::string& filePathWithinArchive) :
+        MapResource(filePathWithinArchive)
+    {}
+
+protected:
+
+};
+
+}
diff --git a/radiantcore/map/Map.cpp b/radiantcore/map/Map.cpp
@@ -101,7 +101,9 @@ void Map::loadMapResourceFromLocation(const MapLocation& location)
 	// Map loading started
 	emitMapEvent(MapLoading);
 
-	_resource = GlobalMapResourceManager().loadFromPath(location.path);
+	_resource = location.isArchive ? 
+        GlobalMapResourceManager().createFromArchiveFile(location.path, location.archiveRelativePath) :
+        GlobalMapResourceManager().createFromPath(location.path);
 
     if (!_resource)
     {
@@ -394,7 +396,7 @@ bool Map::import(const std::string& filename)
 {
     bool success = false;
 
-    IMapResourcePtr resource = GlobalMapResourceManager().loadFromPath(filename);
+    IMapResourcePtr resource = GlobalMapResourceManager().createFromPath(filename);
 
     try
     {

diff --git a/radiantcore/map/MapResource.cpp b/radiantcore/map/MapResource.cpp
@@ -253,11 +253,13 @@ RootNodePtr MapResource::loadMapNode()
 {
 	RootNodePtr rootNode;
 
-	// Build the map path
-	auto fullpath = getAbsoluteResourcePath();
+	// Open a stream - will throw on failure
+    auto stream = openMapfileStream();
 
-	// Open a stream (from physical file or VFS) - will throw on failure
-    auto stream = openFileStream(fullpath);
+    if (!stream || !stream->isOpen())
+    {
+        throw OperationException(_("Could not open map stream"));
+    }
 
     try
     {
@@ -283,31 +285,19 @@ RootNodePtr MapResource::loadMapNode()
         // Check if an info file is supported by this map format
         if (format->allowInfoFileCreation())
         {
-            try
-            {
-                // Load for an additional info file
-                auto infoFilename = fullpath.substr(0, fullpath.rfind('.'));
-                infoFilename += getInfoFileExtension();
+            auto infoFileStream = openInfofileStream();
 
-                auto infoFileStream = openFileStream(infoFilename);
-
-                if (infoFileStream->isOpen())
-                {
-                    loader.loadInfoFile(infoFileStream->getStream(), rootNode);
-                }
-            }
-            catch (const OperationException& ex)
+            if (infoFileStream && infoFileStream->isOpen())
             {
-                // Info file load file does not stop us, just issue a warning
-                rWarning() << ex.what() << std::endl;
+                loader.loadInfoFile(infoFileStream->getStream(), rootNode);
             }
         }
     }
     catch (const OperationException& ex)
     {
         // Re-throw the exception, prepending the map file path to the message (if not cancelled)
         throw ex.operationCancelled() ? ex : 
-            OperationException(fmt::format(_("Failure reading map file:\n{0}\n\n{1}"), fullpath, ex.what()));
+            OperationException(fmt::format(_("Failure reading map file:\n{0}\n\n{1}"), getAbsoluteResourcePath(), ex.what()));
     }
 
 	return rootNode;
@@ -326,6 +316,31 @@ stream::MapResourceStream::Ptr MapResource::openFileStream(const std::string& pa
     return stream;
 }
 
+stream::MapResourceStream::Ptr MapResource::openMapfileStream()
+{
+    return openFileStream(getAbsoluteResourcePath());
+}
+
+stream::MapResourceStream::Ptr MapResource::openInfofileStream()
+{
+    try
+    {
+        auto fullpath = getAbsoluteResourcePath();
+
+        // Load for an additional info file
+        auto infoFilename = fullpath.substr(0, fullpath.rfind('.'));
+        infoFilename += getInfoFileExtension();
+
+        return openFileStream(infoFilename);
+    }
+    catch (const OperationException& ex)
+    {
+        // Info file load file does not stop us, just issue a warning
+        rWarning() << ex.what() << std::endl;
+        return stream::MapResourceStream::Ptr();
+    }
+}
+
 std::string MapResource::getInfoFileExtension()
 {
     std::string extension = game::current::getValue<std::string>(GKEY_INFO_FILE_EXTENSION);

diff --git a/radiantcore/map/MapResource.h b/radiantcore/map/MapResource.h
@@ -2,7 +2,6 @@
 
 #include "imapresource.h"
 #include "imapformat.h"
-#include "imapinfofile.h"
 #include "imodel.h"
 #include "imap.h"
 #include <set>
@@ -50,6 +49,15 @@ class MapResource :
 	static void saveFile(const MapFormat& format, const scene::IMapRootNodePtr& root,
 						 const GraphTraversalFunc& traverse, const std::string& filename);
 
+protected:
+    // Implementation-specific method to open the stream of the primary .map or .mapx file
+    // May return an empty reference, may throw OperationException on failure
+    virtual stream::MapResourceStream::Ptr openMapfileStream();
+
+    // Implementation-specific method to open the info file stream (.darkradiant) file
+    // May return an empty reference, may throw OperationException on failure
+    virtual stream::MapResourceStream::Ptr openInfofileStream();
+
 private:
     void constructPaths(const std::string& resourcePath);
     std::string getAbsoluteResourcePath();
@@ -74,8 +82,5 @@ class MapResource :
 	// Checks if file can be overwritten (throws on failure)
 	static void throwIfNotWriteable(const fs::path& path);
 };
-// Resource pointer types
-typedef std::shared_ptr<MapResource> MapResourcePtr;
-typedef std::weak_ptr<MapResource> MapResourceWeakPtr;
 
 } // namespace map
diff --git a/radiantcore/map/MapResourceManager.cpp b/radiantcore/map/MapResourceManager.cpp
@@ -6,16 +6,22 @@
 #include "os/path.h"
 #include "module/StaticModule.h"
 #include "MapResource.h"
+#include "ArchivedMapResource.h"
 
 namespace map
 {
 
-IMapResourcePtr MapResourceManager::loadFromPath(const std::string& path)
+IMapResourcePtr MapResourceManager::createFromPath(const std::string& path)
 {
-	// Create a new MapResource and return it.
 	return std::make_shared<MapResource>(path);
 }
 
+IMapResourcePtr MapResourceManager::createFromArchiveFile(const std::string& archivePath,
+    const std::string& filePathWithinArchive)
+{
+    return std::make_shared<ArchivedMapResource>(archivePath, filePathWithinArchive);
+}
+
 MapResourceManager::ExportEvent& MapResourceManager::signal_onResourceExporting()
 {
 	return _resourceExporting;
@@ -26,7 +32,6 @@ MapResourceManager::ExportEvent& MapResourceManager::signal_onResourceExported()
 	return _resourceExported;
 }
 
-// RegisterableModule implementation
 const std::string& MapResourceManager::getName() const
 {
 	static std::string _name(MODULE_MAPRESOURCEMANAGER);
@@ -49,7 +54,7 @@ const StringSet& MapResourceManager::getDependencies() const
 
 void MapResourceManager::initialiseModule(const IApplicationContext& ctx)
 {
-	rMessage() << "MapResourceManager::initialiseModule called." << std::endl;
+	rMessage() << getName() << "::initialiseModule called." << std::endl;
 }
 
 // Define the MapResourceManager registerable module

diff --git a/radiantcore/map/MapResourceManager.h b/radiantcore/map/MapResourceManager.h
@@ -14,7 +14,9 @@ class MapResourceManager :
 	ExportEvent _resourceExported;
 
 public:
-	IMapResourcePtr loadFromPath(const std::string& path) override;
+	IMapResourcePtr createFromPath(const std::string& path) override;
+    IMapResourcePtr createFromArchiveFile(const std::string& archivePath,
+        const std::string& filePathWithinArchive) override;
 
 	ExportEvent& signal_onResourceExporting() override;
 	ExportEvent& signal_onResourceExported() override;

diff --git a/tools/msvc/DarkRadiantCore.vcxproj b/tools/msvc/DarkRadiantCore.vcxproj
@@ -803,6 +803,7 @@
     <ClInclude Include="..\..\radiantcore\map\algorithm\MapImporter.h" />
     <ClInclude Include="..\..\radiantcore\map\algorithm\Models.h" />
     <ClInclude Include="..\..\radiantcore\map\algorithm\Skins.h" />
+    <ClInclude Include="..\..\radiantcore\map\ArchivedMapResource.h" />
     <ClInclude Include="..\..\radiantcore\map\AutoSaver.h" />
     <ClInclude Include="..\..\radiantcore\map\CounterManager.h" />
     <ClInclude Include="..\..\radiantcore\map\EditingStopwatch.h" />

diff --git a/tools/msvc/DarkRadiantCore.vcxproj.filters b/tools/msvc/DarkRadiantCore.vcxproj.filters
@@ -2052,5 +2052,8 @@
     <ClInclude Include="..\..\radiantcore\map\MapResourceLoader.h">
       <Filter>src\map</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\radiantcore\map\ArchivedMapResource.h">
+      <Filter>src\map</Filter>
+    </ClInclude>
   </ItemGroup>
 </Project>