Initial draft of savegames

Sections save their runtime state into a SaveSect-<x>-<y>.c4g subgroup; x
denotes an ascending counter for sorting purposes, y the section number.
The exception to this is the first section, which saves into the main group
as well as Game.txt for compatibility.

Author: Fulgen301

src/C4Components.h

@@ -31,6 +31,10 @@
 #define C4CFN_Languages "Language.c4g"
 
 #define C4CFN_ScenarioSections "Sect*.c4g"
+#define C4CFN_Section "Sect{}.c4g"
+#define C4CFN_SectionRuntimeData "Section.txt"
+#define C4CFN_SavedSection "SaveSect{}-{}.c4g"
+#define C4CFN_SavedSectionFiles "SaveSect*.c4g"
 
 #define C4CFN_Mouse    "Mouse.c4f"
 #define C4CFN_Keyboard "Keyboard.c4f"

src/C4Config.cpp

@@ -664,6 +664,12 @@ const char *C4Config::AtTempPath(const char *szFilename)
 	return AtPathFilename;
 }
 
+const char *C4Config::AtTempPathWithPrefix(std::string_view prefix, std::string_view filename)
+{
+	FormatWithNull(AtPathFilename, "{}{}{}", General.TempPath, prefix, filename);
+	return AtPathFilename;
+}
+
 #ifdef C4ENGINE
 
 const char *C4Config::AtNetworkPath(const char *szFilename)

src/C4Config.h

@@ -329,6 +329,7 @@ class C4Config
 	bool Load(bool forceWorkingDirectory = true, const char *szConfigFile = nullptr);
 	bool Init();
 	const char *AtExePath(const char *szFilename);
+	const char *AtTempPathWithPrefix(std::string_view prefix, std::string_view filename);
 	const char *AtTempPath(const char *szFilename);
 #ifdef C4ENGINE
 	const char *AtNetworkPath(const char *szFilename);

src/C4Game.cpp

@@ -392,6 +392,45 @@ bool C4Game::OpenScenario()
 		LogFatal(C4ResStrTableKey::IDS_ERR_LOAD_RUNTIMEDATA); return false;
 	}
 
+	if (C4S.Head.SaveGame)
+	{
+		// Sadly, the first section requires some rather convoluted section loading,
+		// as its data gets deserialized from Game.txt for compatibility with older
+		// save games.s
+		if (!Sections.front()->AssumeGroupAsSaveGameGroup())
+		{
+			LogFatal(C4ResStrTableKey::IDS_ERR_SECTION); return false;
+		}
+
+		std::array<char, _MAX_PATH + 1> filename;
+
+		ScenarioFile.ResetSearch();
+		while (ScenarioFile.FindNextEntry(C4CFN_SavedSectionFiles, filename.data()))
+		{
+			auto section = C4Section::FromSaveGame(ScenarioFile, filename.data());
+			if (!section)
+			{
+				LogFatal(C4ResStrTableKey::IDS_ERR_SECTION); return false;
+			}
+
+			Sections.emplace_back(std::move(section));
+		}
+
+		C4Section::AdjustEnumerationIndex(std::ranges::max(Sections | std::views::transform(&C4Section::Number)) + 1);
+
+		// C4Section::InitFromSaveGameAfterLoad potentially calls C4Section::InitFromTemplate, which calls
+		// C4Group::OpenAsChild, which moves the group search pointer; therefore we can't combine it with the
+		// loop above.
+
+		for (auto &section : Sections | std::views::drop(1))
+		{
+			if (!section->InitFromSaveGameAfterLoad(ScenarioFile))
+			{
+				LogFatal(C4ResStrTableKey::IDS_ERR_SECTION); return false;
+			}
+		}
+	}
+
 	// If scenario is a directory: Watch for changes
 	if (!ScenarioFile.IsPacked())
 	{
@@ -1426,9 +1465,7 @@ void C4Game::CompileFunc(StdCompiler *pComp, CompileSettings comp)
 
 	if (comp.fExact)
 	{
-		pComp->Value(mkNamingAdapt(Sections.front()->Weather,       "Weather")); // FIXME: sections
-		pComp->Value(mkNamingAdapt(Sections.front()->Landscape,     "Landscape"));
-		pComp->Value(mkNamingAdapt(Sections.front()->Landscape.Sky, "Sky"));
+		pComp->Value(mkParAdapt(*Sections.front(), true));
 	}
 
 	pComp->Value(mkNamingAdapt(mkNamingPtrAdapt(Sections.front()->GlobalEffects, "GlobalEffects"), "Effects"));
@@ -1734,6 +1771,7 @@ bool C4Game::QuickSave(const char *strFilename, const char *strTitle, bool fForc
 	{
 		Log(C4ResStrTableKey::IDS_GAME_FAILSAVEGAME); delete pGameSave; return false;
 	}
+
 	delete pGameSave;
 
 	// Success
@@ -2892,6 +2930,13 @@ void C4Game::SectionLoadProc(std::stop_token stopToken)
 
 		{
 			const std::lock_guard lock{SectionLoadMutex};
+
+			if (SectionLoadQueue.empty())
+			{
+				spdlog::error("SectionLoadProc: Semaphore acquired, but queue is empty!");
+				continue;
+			}
+
 			sectionLoadArgs = std::move(SectionLoadQueue.front());
 			SectionLoadQueue.pop();
 		}

src/C4GameObjects.cpp

@@ -684,11 +684,11 @@ int C4GameObjects::Load(C4Section &section, C4Group &hGroup, bool fKeepInactive)
 bool C4GameObjects::Save(C4Section &section, C4Group &hGroup, bool fSaveGame, bool fSaveInactive)
 {
 	// Save to temp file
-	char szFilename[_MAX_PATH + 1]; SCopy(Config.AtTempPath(C4CFN_ScenarioObjects), szFilename);
+	char szFilename[_MAX_PATH + 1]; SCopy(Config.AtTempPathWithPrefix(section.GetNumberAsString(), C4CFN_ScenarioObjects), szFilename);
 	if (!Save(section, szFilename, fSaveGame, fSaveInactive)) return false;
 
 	// Move temp file to group
-	hGroup.Move(szFilename, nullptr); // check?
+	hGroup.Move(szFilename, C4CFN_ScenarioObjects); // check?
 	// Success
 	return true;
 }

src/C4GameSave.cpp

@@ -136,7 +136,7 @@ bool C4GameSave::SaveScenarioSections()
 	return true;
 }
 
-bool C4GameSave::SaveLandscape(C4Section &section)
+bool C4GameSave::SaveLandscape(C4Section &section, C4Group &group)
 {
 	// exact?
 	if (section.Landscape.Mode == C4LSC_Exact || GetForceExactLandscape())
@@ -146,20 +146,20 @@ bool C4GameSave::SaveLandscape(C4Section &section)
 		section.Objects.RemoveSolidMasks();
 		bool fSuccess;
 		if (section.Landscape.Mode == C4LSC_Exact)
-			fSuccess = !!section.Landscape.Save(*pSaveGroup);
+			fSuccess = !!section.Landscape.SaveExact(group);
 		else
-			fSuccess = !!section.Landscape.SaveDiff(*pSaveGroup, !IsSynced());
+			fSuccess = !!section.Landscape.SaveDiff(group, !IsSynced());
 		section.Objects.PutSolidMasks();
 		if (!fSuccess) return false;
 		DBGRECOFF.Clear();
 		// PXS
-		if (!section.PXS.Save(*pSaveGroup)) return false;
+		if (!section.PXS.Save(group)) return false;
 		// MassMover (create copy, may not modify running data)
 		C4MassMoverSet MassMoverSet{section};
 		MassMoverSet.Copy(section.MassMover);
-		if (!MassMoverSet.Save(*pSaveGroup)) return false;
+		if (!MassMoverSet.Save(group)) return false;
 		// Material enumeration
-		if (!section.Material.SaveEnumeration(*pSaveGroup)) return false;
+		if (!section.Material.SaveEnumeration(group)) return false;
 	}
 	// static / dynamic
 	if (section.Landscape.Mode == C4LSC_Static)
@@ -171,9 +171,9 @@ bool C4GameSave::SaveLandscape(C4Section &section)
 		if (!GetForceExactLandscape())
 		{
 			// save map
-			if (!section.Landscape.SaveMap(*pSaveGroup)) return false;
+			if (!section.Landscape.SaveMap(group)) return false;
 			// save textures (if changed)
-			if (!section.Landscape.SaveTextures(*pSaveGroup)) return false;
+			if (!section.Landscape.SaveTextures(group)) return false;
 		}
 	}
 	else if (section.Landscape.Mode != C4LSC_Exact)
@@ -193,11 +193,46 @@ bool C4GameSave::SaveRuntimeData()
 		Log(C4ResStrTableKey::IDS_ERR_SAVE_SCENSECTIONS); return false;
 	}
 
-	for (const auto &section : Game.Sections)
+	if (!SaveSection(*Game.Sections.front(), *pSaveGroup, false))
 	{
-		if (!SaveSection(*section))
+		return false;
+	}
+
+	if (IsExact())
+	{
+		std::size_t counter{1};
+
+		for (auto it = std::next(Game.Sections.begin()); it != Game.Sections.end(); ++it)
 		{
-			return false;
+			C4Section &section{**it};
+			if (!SaveSection(section, std::format(C4CFN_SavedSection, counter++, section.Number), true))
+			{
+				return false;
+			}
+		}
+	}
+	else
+	{
+		for (auto it = std::next(Game.Sections.begin()); it != Game.Sections.end(); ++it)
+		{
+			C4Section &section{**it};
+
+			C4Group sectGroup;
+			const std::string filename{std::format(C4CFN_Section, section.GetNameForSaveGame())};
+			if (sectGroup.OpenAsChild(pSaveGroup, filename.c_str()))
+			{
+				if (!SaveSection(section, sectGroup, true))
+				{
+					return false;
+				}
+			}
+			else
+			{
+				if (!SaveSection(section, filename, true))
+				{
+					return false;
+				}
+			}
 		}
 	}
 
@@ -263,22 +298,77 @@ bool C4GameSave::SaveRuntimeData()
 	return true;
 }
 
-bool C4GameSave::SaveSection(C4Section &section)
+bool C4GameSave::SaveSection(C4Section &section, const std::string &filename, const bool saveRuntimeData)
+{
+	pSaveGroup->SetStdOutput(true);
+	std::string tmpFile{Config.AtTempPath(filename.c_str())};
+	MakeTempFilename(tmpFile.data());
+
+	{
+		C4Group tmpGroup;
+		if (!tmpGroup.Open(tmpFile.c_str(), true))
+		{
+			return false;
+		}
+
+		if (!SaveSection(section, tmpGroup, saveRuntimeData))
+		{
+			return false;
+		}
+
+		tmpGroup.Close();
+	}
+
+	if (!pSaveGroup->Move(tmpFile.c_str(), filename.c_str()))
+	{
+		return false;
+	}
+
+	return true;
+}
+
+bool C4GameSave::SaveSection(C4Section &section, C4Group &group, const bool saveRuntimeData)
 {
 	// landscape
-	if (!SaveLandscape(section))
+	if (!SaveLandscape(section, group))
 	{
 		Log(C4ResStrTableKey::IDS_ERR_SAVE_LANDSCAPE);
 		return false;
 	}
 
 	// Objects
-	if (!section.Objects.Save(section, (*pSaveGroup), IsExact(), true))
+	if (!section.Objects.Save(section, group, IsExact(), true))
 	{
 		Log(C4ResStrTableKey::IDS_ERR_SAVE_OBJECTS);
 		return false;
 	}
 
+	// Save core for non-scenarios
+	if (!IsExact())
+	{
+		C4Scenario c4s;
+		c4s.Animals = rC4S.Animals;
+		c4s.Disasters = rC4S.Disasters;
+		c4s.Environment = rC4S.Environment;
+		c4s.Game = rC4S.Game;
+		c4s.Landscape = rC4S.Landscape;
+		std::ranges::copy(rC4S.PlrStart, c4s.PlrStart);
+		c4s.Weather = rC4S.Weather;
+
+		if (!c4s.Save(group))
+		{
+			return false;
+		}
+	}
+
+	if (saveRuntimeData)
+	{
+		if (!section.SaveRuntimeData(group))
+		{
+			return false;
+		}
+	}
+
 	return true;
 }
 
@@ -308,7 +398,7 @@ bool C4GameSave::SaveDesc(C4Group &hToGroup)
 
 	// Save to file
 	StdStrBuf buf{desc.c_str(), desc.size()};
-	return !!hToGroup.Add(fmt::sprintf(C4CFN_ScenarioDesc, szLang).c_str(), buf, false, true);
+	return !!hToGroup.Add(std::format(C4CFN_ScenarioDesc, szLang).c_str(), buf, false, true);
 }
 
 void C4GameSave::WriteDescLineFeed(std::string &desc)
@@ -500,7 +590,7 @@ bool C4GameSave::Save(C4Group &hToGroup, bool fKeepGroup)
 	{
 		pSaveGroup->Delete(C4CFN_ScenarioTitle);
 		pSaveGroup->Delete(C4CFN_ScenarioIcon);
-		pSaveGroup->Delete(fmt::sprintf(C4CFN_ScenarioDesc, "*").c_str());
+		pSaveGroup->Delete(std::format(C4CFN_ScenarioDesc, "*").c_str());
 		pSaveGroup->Delete(C4CFN_Titles);
 		pSaveGroup->Delete(C4CFN_Info);
 	}
@@ -533,7 +623,12 @@ bool C4GameSave::Close()
 		// close if owned group
 		if (fOwnGroup)
 		{
-			fSuccess = !!pSaveGroup->Close();
+			fSuccess = !!pSaveGroup->Save(false);
+			if (!fSuccess)
+			{
+				LogNTr(spdlog::level::err, "Error closing save file group: {}", pSaveGroup->GetError());
+			}
+			pSaveGroup->Close();
 			delete pSaveGroup;
 			fOwnGroup = false;
 		}

src/C4GameSave.h

@@ -100,9 +100,10 @@ class C4GameSave
 	bool SaveCreateGroup(const char *szFilename, C4Group &hUseGroup); // create/copy group at target filename
 	bool SaveCore(); // save C4S core
 	bool SaveScenarioSections(); // save scenario sections
-	bool SaveLandscape(C4Section &section); // save current landscape
+	bool SaveLandscape(C4Section &section, C4Group &group); // save current landscape
 	bool SaveRuntimeData(); // save any runtime data
-	bool SaveSection(C4Section &section);
+	bool SaveSection(C4Section &section, const std::string &filename, bool saveRuntimeData);
+	bool SaveSection(C4Section &section, C4Group &group, bool saveRuntimeData);
 
 public:
 	virtual ~C4GameSave() { Close(); } // dtor: close group