C4Startup Class Reference

#include <C4Startup.h>

Collaboration diagram for C4Startup:

Public Types
enum	DialogID {   SDID_Main =0 , SDID_ScenSel , SDID_ScenSelNetwork , SDID_NetJoin ,   SDID_Options , SDID_About , SDID_Legal , SDID_PlrSel ,   SDID_Mods , SDID_Back }

Public Member Functions
	C4Startup ()
	~C4Startup ()
void	OnKeyboardLayoutChanged ()
void	OnLeagueOptionChanged ()

Static Public Member Functions
static C4Startup *	EnsureLoaded ()
static void	Unload ()
static void	InitStartup ()
static void	CloseStartup ()
static bool	SetStartScreen (const char *szScreen, const char *szSubDialog=nullptr)
static C4Startup *	Get ()

Public Attributes
C4StartupGraphics	Graphics

Protected Member Functions
void	DoStartup ()
void	DontStartup ()
class C4StartupDlg *	SwitchDialog (DialogID eToDlg, bool fFade=true, const char *szSubDialog=nullptr)

Friends
class	C4StartupMainDlg
class	C4StartupNetDlg
class	C4StartupScenSelDlg
class	C4StartupOptionsDlg
class	C4StartupModsDlg
class	C4StartupAboutDlg
class	C4StartupLegalDlg
class	C4StartupPlrSelDlg

Detailed Description

Definition at line 105 of file C4Startup.h.

Member Enumeration Documentation

DialogID

enum C4Startup::DialogID

Enumerator
SDID_Main
SDID_ScenSel
SDID_ScenSelNetwork
SDID_NetJoin
SDID_Options
SDID_About
SDID_Legal
SDID_PlrSel
SDID_Mods
SDID_Back

Definition at line 114 of file C4Startup.h.

{ SDID_Main=0, SDID_ScenSel, SDID_ScenSelNetwork, SDID_NetJoin, SDID_Options, SDID_About, SDID_Legal, SDID_PlrSel, SDID_Mods, SDID_Back };

Constructor & Destructor Documentation

C4Startup()

C4Startup::C4Startup

(

)

Definition at line 125 of file C4Startup.cpp.

{
    // must be single!
    assert(!pInstance);
    pInstance = this;
}

Referenced by EnsureLoaded().

Here is the caller graph for this function:

~C4Startup()

C4Startup::~C4Startup

(

)

Definition at line 132 of file C4Startup.cpp.

{
    pInstance = nullptr;
    delete pLastDlg;
    delete pCurrDlg;
}

Member Function Documentation

CloseStartup()

void C4Startup::CloseStartup ( )

static

Definition at line 292 of file C4Startup.cpp.

{
    if (pInstance) pInstance->DontStartup();
}

References DontStartup().

Referenced by C4Application::GameTick().

Here is the call graph for this function:

Here is the caller graph for this function:

DontStartup()

void C4Startup::DontStartup ( )

protected

Definition at line 270 of file C4Startup.cpp.

{
    // check whether startup was aborted
    delete pLastDlg; pLastDlg = nullptr;
    if (pCurrDlg)
    {
        // deinit last shown dlg
        if (pCurrDlg->IsShown())
        {
            pCurrDlg->Close(true);
        }
        delete pCurrDlg;
        pCurrDlg = nullptr;
    }
 
    // now no more in startup!
    fInStartup = false;
 
    // after startup: cleanup
    ::pGUI->CloseAllDialogs(true);
}

References C4GUI::Dialog::Close(), C4GUI::Screen::CloseAllDialogs(), C4GUI::Dialog::IsShown(), and pGUI.

Referenced by CloseStartup().

Here is the call graph for this function:

Here is the caller graph for this function:

DoStartup()

void C4Startup::DoStartup ( )

protected

Definition at line 231 of file C4Startup.cpp.

{
    assert(!fInStartup);
    assert(::pGUI);
    // now in startup!
    fInStartup = true;
    fLastDlgWasBack = false;
 
    ::GraphicsSystem.EnableLoaderDrawing();
 
    // clear any previous
    if (pLastDlg) { delete pLastDlg; pLastDlg = nullptr; }
    if (pCurrDlg) { delete pCurrDlg; pCurrDlg = nullptr; }
 
    // start with the last dlg that was shown - at first startup main dialog
    SwitchDialog(eLastDlgID, true, sSubDialog.getData());
 
    // show error dlg if restart
    if (Game.fQuitWithError || GetFatalError())
    {
        Game.fQuitWithError = false;
        // preferred: Show fatal error
        const char *szErr = GetFatalError();
        if (szErr)
        {
            ::pGUI->ShowMessage(szErr, LoadResStr("IDS_DLG_LOG"), C4GUI::Ico_Error);
        }
        else
        {
            // fallback to showing complete log
            StdStrBuf sLastLog;
            if (GetLogSection(Game.StartupLogPos, Game.QuitLogPos - Game.StartupLogPos, sLastLog))
                if (!sLastLog.isNull())
                    ::pGUI->ShowRemoveDlg(new C4GUI::InfoDialog(LoadResStr("IDS_DLG_LOG"), 10, sLastLog));
        }
        ResetFatalError();
    }
}

References C4GraphicsSystem::EnableLoaderDrawing(), C4Game::fQuitWithError, Game, StdStrBuf::getData(), GetFatalError(), GetLogSection(), GraphicsSystem, C4GUI::Ico_Error, StdStrBuf::isNull(), LoadResStr(), pGUI, C4Game::QuitLogPos, ResetFatalError(), C4GUI::Screen::ShowMessage(), C4GUI::Screen::ShowRemoveDlg(), C4Game::StartupLogPos, and SwitchDialog().

Referenced by InitStartup().

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureLoaded()

C4Startup * C4Startup::EnsureLoaded ( )

static

Definition at line 297 of file C4Startup.cpp.

{
    // create and load startup data if not done yet
    assert(::pGUI);
    if (!pInstance)
    {
        Game.SetInitProgress(36.0f);
        C4Startup *pStartup = new C4Startup();
        Game.SetInitProgress(37.0f);
        // load startup specific gfx
        if (!pStartup->Graphics.Init())
            { LogFatal(LoadResStr("IDS_ERR_NOGFXSYS")); delete pStartup; return nullptr; }
    }
    return pInstance;
}

References C4Startup(), Game, Graphics, C4StartupGraphics::Init(), LoadResStr(), LogFatal(), pGUI, and C4Game::SetInitProgress().

Referenced by InitStartup().

Here is the call graph for this function:

Here is the caller graph for this function:

Get()

static C4Startup* C4Startup::Get ( )

inlinestatic

Definition at line 147 of file C4Startup.h.

{ assert(pInstance); return pInstance; }

Referenced by C4StartupMainDlg::C4StartupMainDlg(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupOptionsDlg::C4StartupOptionsDlg(), C4StartupPlrPropertiesDlg::C4StartupPlrPropertiesDlg(), C4StartupPlrSelDlg::C4StartupPlrSelDlg(), C4StartupScenSelDlg::C4StartupScenSelDlg(), C4StartupNetDlg::CreateGame(), C4MapFolderData::CreateGUIElements(), C4StartupAboutDlg::DoBack(), C4StartupLegalDlg::DoBack(), C4StartupModsDlg::DoBack(), C4StartupNetDlg::DoBack(), C4StartupOptionsDlg::DoBack(), C4StartupPlrSelDlg::DoBack(), C4StartupMainDlg::DrawElement(), C4StartupPlrPropertiesDlg::DrawElement(), C4StartupNetListEntry::Execute(), C4ScenarioListLoader::Entry::Load(), C4ScenarioListLoader::Scenario::LoadCustom(), C4ScenarioListLoader::SubFolder::LoadCustom(), C4ScenarioListLoader::RegularFolder::LoadCustom(), C4StartupModsListEntry::MakeInfoEntry(), C4StartupMainDlg::OnAboutBtn(), C4GameOptionButtons::OnBtnLeague(), C4StartupScenSelDlg::OnClosed(), C4Application::OnKeyboardLayoutChanged(), C4StartupAboutDlg::OnLegalBtn(), C4StartupMainDlg::OnModsBtn(), C4StartupMainDlg::OnNetJoinBtn(), C4StartupMainDlg::OnOptionsBtn(), C4StartupMainDlg::OnPlayerSelectionBtn(), C4StartupMainDlg::OnStartBtn(), C4StartupOptionsDlg::RecreateDialog(), C4StartupScenSelDlg::ScenListItem::ScenListItem(), C4Application::SetGameFont(), C4StartupNetListEntry::SetReference(), C4StartupNetListEntry::SetRefQuery(), and C4StartupPlrSelDlg::PlayerListItem::SetSelectionInfo().

Here is the caller graph for this function:

InitStartup()

void C4Startup::InitStartup ( )

static

Definition at line 319 of file C4Startup.cpp.

{
    // ensure gfx are loaded
    C4Startup *pStartup = EnsureLoaded();
    if (!pStartup)
    {
        Application.Quit();
        return;
    }
    // exec it
    pStartup->DoStartup();
}

References Application, DoStartup(), EnsureLoaded(), and C4Application::Quit().

Referenced by C4Application::PreInit().

Here is the call graph for this function:

Here is the caller graph for this function:

OnKeyboardLayoutChanged()

void C4Startup::OnKeyboardLayoutChanged

(

)

Definition at line 365 of file C4Startup.cpp.

{
    // forward message to current dialog
    if (pCurrDlg) pCurrDlg->OnKeyboardLayoutChanged();
}

References C4StartupDlg::OnKeyboardLayoutChanged().

Referenced by C4Application::OnKeyboardLayoutChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

OnLeagueOptionChanged()

void C4Startup::OnLeagueOptionChanged

(

)

Definition at line 371 of file C4Startup.cpp.

{
    // forward message to current dialog
    if (pCurrDlg) pCurrDlg->OnLeagueOptionChanged();
}

References C4StartupDlg::OnLeagueOptionChanged().

Referenced by C4GameOptionButtons::OnBtnLeague().

Here is the call graph for this function:

Here is the caller graph for this function:

SetStartScreen()

bool C4Startup::SetStartScreen ( const char *  szScreen, const char *  szSubDialog = nullptr  )

static

Definition at line 332 of file C4Startup.cpp.

{
    sSubDialog.Clear();
    if (szSubDialog != nullptr)
        sSubDialog = szSubDialog;
 
    // set dialog ID to be shown to specified value
    if (SEqualNoCase(szScreen, "main"))
        eLastDlgID = SDID_Main;
    if (SEqualNoCase(szScreen, "scen"))
        eLastDlgID = SDID_ScenSel;
    if (SEqualNoCase(szScreen, "netscen"))
        eLastDlgID = SDID_ScenSelNetwork;
    else if (SEqualNoCase(szScreen, "net"))
        eLastDlgID = SDID_NetJoin;
    else if (SEqualNoCase(szScreen, "mods"))
        eLastDlgID = SDID_Mods;
    else if (SEqualNoCase(szScreen, "options"))
        eLastDlgID = SDID_Options;
    else if (SEqual2NoCase(szScreen, "options-"))
    {
        eLastDlgID = SDID_Options;
        // subscreen of options
        sSubDialog.Copy(szScreen+8);
    }
    else if (SEqualNoCase(szScreen, "plrsel"))
        eLastDlgID = SDID_PlrSel;
    else if (SEqualNoCase(szScreen, "about"))
        eLastDlgID = SDID_About;
    else return false;
    return true;
}

References StdStrBuf::Clear(), StdStrBuf::Copy(), SDID_About, SDID_Main, SDID_Mods, SDID_NetJoin, SDID_Options, SDID_PlrSel, SDID_ScenSel, SDID_ScenSelNetwork, SEqual2NoCase(), and SEqualNoCase().

Referenced by C4Application::ParseCommandLine().

Here is the call graph for this function:

Here is the caller graph for this function:

SwitchDialog()

C4StartupDlg * C4Startup::SwitchDialog ( DialogID  eToDlg, bool  fFade = true, const char *  szSubDialog = nullptr  )

protected

Definition at line 139 of file C4Startup.cpp.

{
#ifdef USE_CONSOLE
    return nullptr;
#else
    // can't go back twice, because dialog is not remembered: Always go back to main in this case
    if (eToDlg == SDID_Back && (fLastDlgWasBack || !pLastDlg)) eToDlg = SDID_Main;
    fLastDlgWasBack = false;
    // create new dialog
    C4StartupDlg *pToDlg = nullptr;
    switch (eToDlg)
    {
    case SDID_Main:
        pToDlg = new C4StartupMainDlg();
        break;
    case SDID_ScenSel:
        pToDlg = new C4StartupScenSelDlg(false);
        break;
    case SDID_ScenSelNetwork:
        pToDlg = new C4StartupScenSelDlg(true);
        break;
    case SDID_NetJoin:
        pToDlg = new C4StartupNetDlg();
        break;
    case SDID_Options:
        pToDlg = new C4StartupOptionsDlg();
        break;
    case SDID_About:
        pToDlg = new C4StartupAboutDlg();
        break;
    case SDID_Legal:
        pToDlg = new C4StartupLegalDlg();
        break;
    case SDID_PlrSel:
        pToDlg = new C4StartupPlrSelDlg();
        break;
    case SDID_Mods:
        pToDlg = new C4StartupModsDlg();
        break;
    case SDID_Back:
        pToDlg = pLastDlg;
        fLastDlgWasBack = true;
        break;
    };
    assert(pToDlg);
    if (!pToDlg) return nullptr;
    if (pToDlg != pLastDlg)
    {
        // remember current position
        eLastDlgID = eToDlg;
        // kill any old dialog
        if (pLastDlg) delete pLastDlg;
    }
    // retain current dialog as last, so it can fade out and may be used later
    if ((pLastDlg = pCurrDlg))
    {
        if (fFade)
        {
            if (!pLastDlg->IsShown()) pLastDlg->Show(::pGUI, false);
            pLastDlg->FadeOut(true);
        }
        else
        {
            delete pLastDlg;
            pLastDlg = nullptr;
        }
    }
    // Okay; now using this dialog
    pCurrDlg = pToDlg;
    // go to dialog subscreen
    if (szSubDialog) pCurrDlg->SetSubscreen(szSubDialog);
    // fade in new dlg
    if (fFade)
    {
        if (!pToDlg->FadeIn(::pGUI))
        {
            delete pToDlg; pCurrDlg=nullptr;
            return nullptr;
        }
    }
    else
    {
        if (!pToDlg->Show(::pGUI, true))
        {
            delete pToDlg; pCurrDlg=nullptr;
            return nullptr;
        }
    }
    return pToDlg;
#endif
}

References C4StartupAboutDlg, C4StartupLegalDlg, C4StartupMainDlg, C4StartupModsDlg, C4StartupNetDlg, C4StartupOptionsDlg, C4StartupPlrSelDlg, C4StartupScenSelDlg, C4GUI::Dialog::FadeIn(), C4GUI::Dialog::FadeOut(), C4GUI::Dialog::IsShown(), pGUI, SDID_About, SDID_Back, SDID_Legal, SDID_Main, SDID_Mods, SDID_NetJoin, SDID_Options, SDID_PlrSel, SDID_ScenSel, SDID_ScenSelNetwork, C4StartupDlg::SetSubscreen(), and C4GUI::Dialog::Show().

Referenced by C4StartupNetDlg::CreateGame(), C4StartupAboutDlg::DoBack(), C4StartupLegalDlg::DoBack(), C4StartupModsDlg::DoBack(), C4StartupNetDlg::DoBack(), C4StartupOptionsDlg::DoBack(), C4StartupPlrSelDlg::DoBack(), DoStartup(), C4StartupMainDlg::OnAboutBtn(), C4StartupScenSelDlg::OnClosed(), C4StartupAboutDlg::OnLegalBtn(), C4StartupMainDlg::OnModsBtn(), C4StartupMainDlg::OnNetJoinBtn(), C4StartupMainDlg::OnOptionsBtn(), C4StartupMainDlg::OnPlayerSelectionBtn(), C4StartupMainDlg::OnStartBtn(), and C4StartupOptionsDlg::RecreateDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

Unload()

void C4Startup::Unload ( )

static

Definition at line 313 of file C4Startup.cpp.

{
    // make sure startup data is destroyed
    if (pInstance) { delete pInstance; pInstance=nullptr; }
}

Referenced by C4Game::Init(), C4Application::Quit(), and C4Game::~C4Game().

Here is the caller graph for this function:

Friends And Related Function Documentation

C4StartupAboutDlg

friend class C4StartupAboutDlg

friend

Definition at line 134 of file C4Startup.h.

Referenced by SwitchDialog().

C4StartupLegalDlg

friend class C4StartupLegalDlg

friend

Definition at line 135 of file C4Startup.h.

Referenced by SwitchDialog().

C4StartupMainDlg

friend class C4StartupMainDlg

friend

Definition at line 129 of file C4Startup.h.

Referenced by SwitchDialog().

C4StartupModsDlg

friend class C4StartupModsDlg

friend

Definition at line 133 of file C4Startup.h.

Referenced by SwitchDialog().

C4StartupNetDlg

friend class C4StartupNetDlg

friend

Definition at line 130 of file C4Startup.h.

Referenced by SwitchDialog().

C4StartupOptionsDlg

friend class C4StartupOptionsDlg

friend

Definition at line 132 of file C4Startup.h.

Referenced by SwitchDialog().

C4StartupPlrSelDlg

friend class C4StartupPlrSelDlg

friend

Definition at line 136 of file C4Startup.h.

Referenced by SwitchDialog().

C4StartupScenSelDlg

friend class C4StartupScenSelDlg

friend

Definition at line 131 of file C4Startup.h.

Referenced by SwitchDialog().

Member Data Documentation

Graphics

C4StartupGraphics C4Startup::Graphics

Definition at line 112 of file C4Startup.h.

Referenced by C4StartupMainDlg::C4StartupMainDlg(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupOptionsDlg::C4StartupOptionsDlg(), C4StartupPlrPropertiesDlg::C4StartupPlrPropertiesDlg(), C4StartupScenSelDlg::C4StartupScenSelDlg(), C4MapFolderData::CreateGUIElements(), C4StartupMainDlg::DrawElement(), C4StartupPlrPropertiesDlg::DrawElement(), EnsureLoaded(), C4ScenarioListLoader::Entry::Load(), C4StartupModsListEntry::MakeInfoEntry(), C4StartupScenSelDlg::ScenListItem::ScenListItem(), C4Application::SetGameFont(), C4StartupNetListEntry::SetRefQuery(), and C4StartupPlrSelDlg::PlayerListItem::SetSelectionInfo().

---

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

• C4Startup.h
• C4Startup.cpp