C4ScenarioListLoader Class Reference

#include <C4StartupScenSelDlg.h>

Classes
class	Entry
class	Folder
class	RegularFolder
class	Scenario
class	SubFolder

Public Member Functions
	C4ScenarioListLoader (const C4ScenarioParameters &Achievements)
	~C4ScenarioListLoader ()
bool	DoProcessCallback (int32_t iProgress, int32_t iMaxProgress, const char *current_load_info)
bool	Load (const StdStrBuf &sRootFolder)
bool	Load (Folder *pSpecifiedFolder, bool fReload)
bool	LoadExtended (Entry *pEntry)
bool	FolderBack ()
bool	ReloadCurrent ()
bool	IsLoading () const
Entry *	GetFirstEntry () const
Folder *	GetCurrFolder () const
Folder *	GetRootFolder () const
int32_t	GetProgress () const
int32_t	GetMaxProgress () const
int32_t	GetProgressPercent () const
const char *	GetProgressInfo () const
const C4ScenarioParameters &	GetAchievements () const

Detailed Description

Definition at line 42 of file C4StartupScenSelDlg.h.

Constructor & Destructor Documentation

C4ScenarioListLoader()

C4ScenarioListLoader::C4ScenarioListLoader

(

const C4ScenarioParameters &

Achievements

)

Definition at line 1178 of file C4StartupScenSelDlg.cpp.

                                                                                   : Achievements(Achievements), pRootFolder(nullptr), pCurrFolder(nullptr),
        iLoading(0), iProgress(0), iMaxProgress(0), fAbortThis(false), fAbortPrevious(false)
{
}

~C4ScenarioListLoader()

C4ScenarioListLoader::~C4ScenarioListLoader

(

)

Definition at line 1183 of file C4StartupScenSelDlg.cpp.

{
    if (pRootFolder) delete pRootFolder;
}

Member Function Documentation

DoProcessCallback()

bool C4ScenarioListLoader::DoProcessCallback	(	int32_t	iProgress,
		int32_t	iMaxProgress,
		const char *	current_load_info
	)

Definition at line 1220 of file C4StartupScenSelDlg.cpp.

{
    this->iProgress = iProgress;
    this->iMaxProgress = iMaxProgress;
    this->current_load_info.Copy(current_load_info);
    // callback to dialog
    if (C4StartupScenSelDlg::pInstance) C4StartupScenSelDlg::pInstance->ProcessCallback();
    // process callback - abort at a few ugly circumstances...
    // schedule with 1ms delay to force event processing
    // (delay 0 would be nice, but isn't supported properly by our Windows implementation of ScheduleProcs)
    if (!Application.ScheduleProcs(1) // WM_QUIT message?
        || !C4StartupScenSelDlg::pInstance // host dialog removed?
        || !C4StartupScenSelDlg::pInstance->IsShown() // host dialog closed?
       ) return false;
    // and also abort if flagged
    return !fAbortThis;
}

References Application, C4GUI::Dialog::IsShown(), C4StartupScenSelDlg::pInstance, C4StartupScenSelDlg::ProcessCallback(), and StdScheduler::ScheduleProcs().

Referenced by C4ScenarioListLoader::SubFolder::DoLoadContents(), and C4ScenarioListLoader::RegularFolder::DoLoadContents().

Here is the call graph for this function:

Here is the caller graph for this function:

FolderBack()

bool C4ScenarioListLoader::FolderBack

(

)

Definition at line 1276 of file C4StartupScenSelDlg.cpp.

{
    // call safety
    if (!pRootFolder || !pCurrFolder) return false;
    // already in root: Can't go up
    if (pCurrFolder == pRootFolder) return false;
    // otherwise, up one level
    return Load(pCurrFolder->GetParent(), false);
}

References C4ScenarioListLoader::Entry::GetParent(), and Load().

Referenced by C4StartupScenSelDlg::DoBack().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAchievements()

const C4ScenarioParameters& C4ScenarioListLoader::GetAchievements ( ) const

inline

Definition at line 268 of file C4StartupScenSelDlg.h.

{ return Achievements; }

GetCurrFolder()

Folder* C4ScenarioListLoader::GetCurrFolder ( ) const

inline

Definition at line 260 of file C4StartupScenSelDlg.h.

{ return pCurrFolder; }

GetFirstEntry()

Entry* C4ScenarioListLoader::GetFirstEntry ( ) const

inline

Definition at line 258 of file C4StartupScenSelDlg.h.

{ return pCurrFolder ? pCurrFolder->GetFirstEntry() : nullptr; }

References C4ScenarioListLoader::Folder::GetFirstEntry().

Here is the call graph for this function:

GetMaxProgress()

int32_t C4ScenarioListLoader::GetMaxProgress ( ) const

inline

Definition at line 264 of file C4StartupScenSelDlg.h.

{ return iMaxProgress; }

GetProgress()

int32_t C4ScenarioListLoader::GetProgress ( ) const

inline

Definition at line 263 of file C4StartupScenSelDlg.h.

{ return iProgress; }

GetProgressInfo()

const char* C4ScenarioListLoader::GetProgressInfo ( ) const

inline

Definition at line 266 of file C4StartupScenSelDlg.h.

{ return current_load_info.getData(); }

References StdStrBuf::getData().

Here is the call graph for this function:

GetProgressPercent()

int32_t C4ScenarioListLoader::GetProgressPercent ( ) const

inline

Definition at line 265 of file C4StartupScenSelDlg.h.

{ return iProgress * 100 / std::max<int32_t>(iMaxProgress, 1); }

GetRootFolder()

Folder* C4ScenarioListLoader::GetRootFolder ( ) const

inline

Definition at line 261 of file C4StartupScenSelDlg.h.

{ return pRootFolder; }

IsLoading()

bool C4ScenarioListLoader::IsLoading ( ) const

inline

Definition at line 257 of file C4StartupScenSelDlg.h.

{ return !!iLoading; }

Referenced by C4StartupScenSelDlg::DoBack(), and C4StartupScenSelDlg::DoRefresh().

Here is the caller graph for this function:

Load() [1/2]

bool C4ScenarioListLoader::Load

(

const StdStrBuf &

sRootFolder

)

Definition at line 1238 of file C4StartupScenSelDlg.cpp.

{
    // (unthreaded) loading of all entries in root folder
    if (!BeginActivity(true)) return false;
    if (pRootFolder) { delete pRootFolder; pRootFolder = nullptr; }
    pCurrFolder = pRootFolder = new RegularFolder(this, nullptr);
    // Load regular game data if no explicit path specified
    if(!sRootFolder.getData())
        for(const auto & iter : Reloc)
            pRootFolder->Merge(iter.strBuf.getData());
    bool fSuccess = pRootFolder->LoadContents(this, nullptr, &sRootFolder, false, false);
    EndActivity();
    return fSuccess;
}

References StdStrBuf::getData(), C4ScenarioListLoader::Folder::LoadContents(), C4ScenarioListLoader::RegularFolder::Merge(), and Reloc.

Referenced by FolderBack(), C4ScenarioListLoader::Scenario::LoadCustomPre(), C4StartupScenSelDlg::OnShown(), C4StartupScenSelDlg::OpenFolder(), and ReloadCurrent().

Here is the call graph for this function:

Here is the caller graph for this function:

Load() [2/2]

bool C4ScenarioListLoader::Load	(	Folder *	pSpecifiedFolder,
		bool	fReload
	)

Definition at line 1253 of file C4StartupScenSelDlg.cpp.

{
    // call safety
    if (!pRootFolder || !pSpecifiedFolder) return false;
    // set new current and load it
    if (!BeginActivity(true)) return false;
    pCurrFolder = pSpecifiedFolder;
    bool fSuccess = pCurrFolder->LoadContents(this, nullptr, nullptr, false, fReload);
    EndActivity();
    return fSuccess;
}

References C4ScenarioListLoader::Folder::LoadContents().

Here is the call graph for this function:

LoadExtended()

bool C4ScenarioListLoader::LoadExtended

(

Entry *

pEntry

)

Definition at line 1265 of file C4StartupScenSelDlg.cpp.

{
    // call safety
    if (!pRootFolder || !pEntry) return false;
    // load info of selection
    if (!BeginActivity(false)) return false;
    bool fSuccess = pEntry->Load(nullptr, nullptr, true);
    EndActivity();
    return fSuccess;
}

References C4ScenarioListLoader::Entry::Load().

Here is the call graph for this function:

ReloadCurrent()

bool C4ScenarioListLoader::ReloadCurrent

(

)

Definition at line 1286 of file C4StartupScenSelDlg.cpp.

{
    // call safety
    if (!pRootFolder || !pCurrFolder) return false;
    // reload current
    return Load(pCurrFolder, true);
}

References Load().

Referenced by C4StartupScenSelDlg::DoRefresh().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• C4StartupScenSelDlg.h
• C4StartupScenSelDlg.cpp