#include <C4Scenario.h>

Collaboration diagram for C4ScenarioSection:

Public Member Functions
	C4ScenarioSection (const char *szName)

	~C4ScenarioSection ()

bool	ScenarioLoad (const char *szFilename, bool is_temp_file)

C4Group *	GetGroupfile (C4Group &rGrp)

bool	EnsureTempStore (bool fExtractLandscape, bool fExtractObjects)

Public Attributes
StdCopyStrBuf	name

StdCopyStrBuf	temp_filename

StdCopyStrBuf	filename

bool	fModified

class C4ScenarioObjectsScriptHost *	pObjectScripts

C4ScenarioSection *	pNext

Detailed Description

Definition at line 253 of file C4Scenario.h.

Constructor & Destructor Documentation

◆ C4ScenarioSection()

C4ScenarioSection::C4ScenarioSection ( const char * szName )

Definition at line 27 of file C4ScenarioSection.cpp.

 {
     // copy name
     name.Copy(szName);
     // zero fields
     fModified = false;
     pObjectScripts = nullptr;
     // link into main list
     pNext = Game.pScenarioSections;
     Game.pScenarioSections = this;
 }

References StdStrBuf::Copy(), fModified, Game, name, pNext, pObjectScripts, and C4Game::pScenarioSections.

Here is the call graph for this function:

◆ ~C4ScenarioSection()

C4ScenarioSection::~C4ScenarioSection ( )

Definition at line 39 of file C4ScenarioSection.cpp.

 {
     // del following scenario sections
     while (pNext)
     {
         C4ScenarioSection *pDel = pNext;
         pNext = pNext->pNext;
         pDel->pNext = nullptr;
         delete pDel;
     }
     // del temp file
     if (temp_filename.getData())
     {
         EraseItem(temp_filename.getData());
     }
 }

References EraseItem(), StdStrBuf::getData(), pNext, and temp_filename.

Here is the call graph for this function:

Member Function Documentation

◆ EnsureTempStore()

bool C4ScenarioSection::EnsureTempStore	(	bool	fExtractLandscape,
		bool	fExtractObjects
	)

Definition at line 116 of file C4ScenarioSection.cpp.

 {
     // if it's temp store already, don't do anything
     if (temp_filename.getData()) return true;
     // make temp filename
     char *szTmp = const_cast<char *>(Config.AtTempPath(filename.getData() ? GetFilename(filename.getData()) : name.getData()));
     MakeTempFilename(szTmp);
     // main section: extract section files from main scenario group (create group as open dir)
     if (!filename.getData())
     {
         if (!CreatePath(szTmp)) return false;
         C4Group hGroup;
         if (!hGroup.Open(szTmp, true)) { EraseItem(szTmp); return false; }
         // extract all desired section files
         Game.ScenarioFile.ResetSearch();
         char fn[_MAX_FNAME_LEN]; *fn=0;
         while (Game.ScenarioFile.FindNextEntry(C4FLS_Section, fn))
             if (fExtractLandscape || !WildcardMatch(C4FLS_SectionLandscape, fn))
                 if (fExtractObjects || !WildcardMatch(C4FLS_SectionObjects, fn))
                     Game.ScenarioFile.ExtractEntry(fn, szTmp);
         hGroup.Close();
     }
     else
     {
         // subsection: simply extract section from main group
         if (!Game.ScenarioFile.ExtractEntry(filename.getData(), szTmp)) return false;
         // delete undesired landscape/object files
         if (!fExtractLandscape || !fExtractObjects)
         {
             C4Group hGroup;
             if (hGroup.Open(filename.getData()))
             {
                 if (!fExtractLandscape) hGroup.Delete(C4FLS_SectionLandscape);
                 if (!fExtractObjects) hGroup.Delete(C4FLS_SectionObjects);
             }
         }
     }
     // copy temp filename
     temp_filename.Copy(szTmp);
     // done, success
     return true;
 }

References _MAX_FNAME_LEN, C4Config::AtTempPath(), C4FLS_Section, C4FLS_SectionLandscape, C4FLS_SectionObjects, C4Group::Close(), Config, StdStrBuf::Copy(), CreatePath(), C4Group::Delete(), EraseItem(), C4Group::ExtractEntry(), filename, C4Group::FindNextEntry(), Game, StdStrBuf::getData(), GetFilename(), MakeTempFilename(), name, C4Group::Open(), C4Group::ResetSearch(), C4Game::ScenarioFile, temp_filename, and WildcardMatch().

Referenced by C4Game::LoadScenarioSection(), and ScenarioLoad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGroupfile()

C4Group * C4ScenarioSection::GetGroupfile ( C4Group & rGrp )

Definition at line 96 of file C4ScenarioSection.cpp.

 {
     // check temp filename
     if (temp_filename.getData())
     {
         if (rGrp.Open(temp_filename.getData())) return &rGrp;
         else return nullptr;
     }
     // check filename within scenario
     if (filename.getData())
     {
         if (rGrp.OpenAsChild(&Game.ScenarioFile, filename.getData())) return &rGrp;
         else return nullptr;
     }
     // unmodified main section: return main group
     if (SEqualNoCase(name.getData(), C4ScenSect_Main)) return &Game.ScenarioFile;
     // failure
     return nullptr;
 }

References C4ScenSect_Main, filename, Game, StdStrBuf::getData(), name, C4Group::Open(), C4Group::OpenAsChild(), C4Game::ScenarioFile, SEqualNoCase(), and temp_filename.

Referenced by C4Game::LoadScenarioSection(), and ScenarioLoad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScenarioLoad()

bool C4ScenarioSection::ScenarioLoad	(	const char *	szFilename,
		bool	is_temp_file
	)

Definition at line 56 of file C4ScenarioSection.cpp.

 {
     // safety
     if (filename.getData() || !szFilename) return false;
     // store name
     filename.Copy(szFilename);
     if (is_temp_file)
     {
         // temp: Remember temp filename to be deleted on destruction
         temp_filename.Copy(szFilename);
     }
     else
     {
         // non-temp: extract if it's not an open folder
         if (Game.ScenarioFile.IsPacked()) if (!EnsureTempStore(true, true)) return false;
     }
     // load section object script
     if (!SEqualNoCase(name.getData(), C4ScenSect_Main))
     {
         C4Group GrpSect, *pGrp;
         if ((pGrp = GetGroupfile(GrpSect)) && pGrp->FindEntry(C4CFN_ScenarioObjectsScript))
         {
             pObjectScripts = new C4ScenarioObjectsScriptHost();
             pObjectScripts->Reg2List(&::ScriptEngine);
             pObjectScripts->Load(*pGrp, C4CFN_ScenarioObjectsScript, Config.General.LanguageEx, &::Game.ScenarioLangStringTable);
         }
         else
         {
             pObjectScripts = nullptr;
         }
     }
     else
     {
         // Object script for main section
         pObjectScripts = ::Game.pScenarioObjectsScript;
     }
     // donce, success
     return true;
 }