C4Scoreboard Class Reference

#include <C4Scoreboard.h>

Collaboration diagram for C4Scoreboard:

Public Types
enum	{ TitleKey = -1 }

Public Member Functions
	C4Scoreboard ()=default
	~C4Scoreboard ()
void	Clear ()
void	SetCell (int32_t iColKey, int32_t iRowKey, const char *szValue, int32_t iValue)
const char *	GetCellString (int32_t iColKey, int32_t iRowKey)
int32_t	GetCellData (int32_t iColKey, int32_t iRowKey)
void	RemoveCol (int32_t iColKey)
void	RemoveRow (int32_t iRowKey)
bool	SortBy (int32_t iColKey, bool fReverse)
void	DoDlgShow (int32_t iChange, bool fUserToggle)
void	HideDlg ()
bool	ShouldBeShown ()
bool	CanBeShown ()
bool	KeyUserShow ()
void	CompileFunc (StdCompiler *pComp)

Protected Member Functions
Entry *	GetCell (int32_t iCol, int32_t iRow) const

Protected Attributes
class C4ScoreboardDlg *	pDlg {nullptr}
int32_t	iDlgShow {0}

Friends
class	C4ScoreboardDlg

Detailed Description

Definition at line 21 of file C4Scoreboard.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
TitleKey

Definition at line 24 of file C4Scoreboard.h.

{ TitleKey = -1 }; // value used to index the title bars

Constructor & Destructor Documentation

C4Scoreboard()

C4Scoreboard::C4Scoreboard ( )

default

~C4Scoreboard()

C4Scoreboard::~C4Scoreboard ( )

inline

Definition at line 70 of file C4Scoreboard.h.

{ Clear(); }

References Clear().

Here is the call graph for this function:

Member Function Documentation

CanBeShown()

bool C4Scoreboard::CanBeShown ( )

inline

Definition at line 84 of file C4Scoreboard.h.

{ return iDlgShow>=0 && iRows && iCols; }

References iDlgShow.

Referenced by DoDlgShow().

Here is the caller graph for this function:

Clear()

void C4Scoreboard::Clear

(

)

Definition at line 64 of file C4Scoreboard.cpp.

{
    // del all cells
    delete [] pEntries;
    pEntries = nullptr; iRows=iCols=0;
    // del dialog
    iDlgShow = 0;
    if (pDlg) { delete pDlg; pDlg = nullptr; }
}

References iDlgShow, and pDlg.

Referenced by C4Game::Clear(), CompileFunc(), and ~C4Scoreboard().

Here is the caller graph for this function:

CompileFunc()

void C4Scoreboard::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 315 of file C4Scoreboard.cpp.

{
    bool deserializing = pComp->isDeserializer();
    if (deserializing) Clear();
    pComp->Value(mkNamingAdapt(iRows,     "Rows",     0));
    pComp->Value(mkNamingAdapt(iCols,     "Cols",     0));
    pComp->Value(mkNamingAdapt(iDlgShow,  "DlgShow",  0));
    if (iRows * iCols)
    {
        if (deserializing) pEntries = new Entry[iRows * iCols];
        for (int32_t iRow = 0; iRow < iRows; ++iRow)
            for (int32_t iCol = 0; iCol < iCols; ++iCol)
            {
                Entry *pEnt = GetCell(iCol, iRow);
                pComp->Value(mkNamingAdapt(pEnt->Text, FormatString("Cell%i_%iString", iCol, iRow).getData()));
                pComp->Value(mkNamingAdapt(pEnt->iVal, FormatString("Cell%i_%iValue", iCol, iRow).getData()));
            }
        // recheck dlg show in read mode
        // will usually not do anything, because reading is done before enetering shared mode
        if (pComp->isDeserializer()) DoDlgShow(0, false);
    }
}

References Clear(), DoDlgShow(), FormatString(), GetCell(), iDlgShow, StdCompiler::isDeserializer(), mkNamingAdapt(), and StdCompiler::Value().

Here is the call graph for this function:

DoDlgShow()

void C4Scoreboard::DoDlgShow	(	int32_t	iChange,
		bool	fUserToggle
	)

Definition at line 285 of file C4Scoreboard.cpp.

{
    if (::pGUI->IsExclusive()) return;
    // update dlg show
    iDlgShow += iChange;
    if (!fUserToggle)
        // script update: Dlg on off if iDlgShow variable passed zero
        fUserToggle = (ShouldBeShown() == !pDlg);
    else
        // user pressed Tab: Always toggle except if the scoreboard cannot be shown at all
        if (!CanBeShown() && !pDlg) fUserToggle = false;
    if (fUserToggle)
    {
        if (!pDlg)
        {
            if (!C4GameOverDlg::IsShown()) // never show during game over dlg
                ::pGUI->ShowRemoveDlg(pDlg = new C4ScoreboardDlg(this));
        }
        else
            pDlg->Close(false);
    }
}

References CanBeShown(), C4GUI::Dialog::Close(), iDlgShow, C4GUI::Screen::IsExclusive(), C4GameOverDlg::IsShown(), pDlg, pGUI, ShouldBeShown(), and C4GUI::Screen::ShowRemoveDlg().

Referenced by CompileFunc(), C4Game::Init(), and KeyUserShow().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCell()

Entry* C4Scoreboard::GetCell ( int32_t  iCol, int32_t  iRow  ) const

inlineprotected

Definition at line 64 of file C4Scoreboard.h.

{ return pEntries+iRow*iCols+iCol; }

Referenced by CompileFunc(), C4ScoreboardDlg::DrawElement(), GetCellData(), GetCellString(), SetCell(), SortBy(), and C4ScoreboardDlg::Update().

Here is the caller graph for this function:

GetCellData()

int32_t C4Scoreboard::GetCellData	(	int32_t	iColKey,
		int32_t	iRowKey
	)

Definition at line 225 of file C4Scoreboard.cpp.

{
    // get row/col
    int32_t iCol = GetColByKey(iColKey);
    int32_t iRow = GetRowByKey(iRowKey);
    if (iCol<0 || iRow<0) return 0;
    // now get value
    Entry *pCell = GetCell(iCol, iRow);
    return pCell->iVal;
}

References GetCell().

Here is the call graph for this function:

GetCellString()

const char * C4Scoreboard::GetCellString	(	int32_t	iColKey,
		int32_t	iRowKey
	)

Definition at line 214 of file C4Scoreboard.cpp.

{
    // get row/col
    int32_t iCol = GetColByKey(iColKey);
    int32_t iRow = GetRowByKey(iRowKey);
    if (iCol<0 || iRow<0) return nullptr;
    // now get value
    Entry *pCell = GetCell(iCol, iRow);
    return pCell->Text.getData();
}

References GetCell().

Here is the call graph for this function:

HideDlg()

void C4Scoreboard::HideDlg

(

)

Definition at line 308 of file C4Scoreboard.cpp.

{
    if (::pGUI->IsExclusive()) return;
    // hide scoreboard if it was active
    if (pDlg) pDlg->Close(false);
}

References C4GUI::Dialog::Close(), C4GUI::Screen::IsExclusive(), pDlg, and pGUI.

Referenced by C4GameOverDlg::OnShown().

Here is the call graph for this function:

Here is the caller graph for this function:

KeyUserShow()

bool C4Scoreboard::KeyUserShow ( )

inline

Definition at line 86 of file C4Scoreboard.h.

{ DoDlgShow(0, true); return true; }

References DoDlgShow().

Referenced by C4Game::InitKeyboard().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveCol()

void C4Scoreboard::RemoveCol

(

int32_t

iColKey

)

Definition at line 236 of file C4Scoreboard.cpp.

{
    int32_t iCol = GetColByKey(iColKey);
    if (iCol>=0) DelCol(iCol);
    InvalidateRows(); // recalc row widths in display
}

RemoveRow()

void C4Scoreboard::RemoveRow

(

int32_t

iRowKey

)

Definition at line 243 of file C4Scoreboard.cpp.

{
    int32_t iRow = GetRowByKey(iRowKey);
    if (iRow>=0) DelRow(iRow);
    InvalidateRows(); // recalc row widths in display
}

SetCell()

void C4Scoreboard::SetCell	(	int32_t	iColKey,
		int32_t	iRowKey,
		const char *	szValue,
		int32_t	iValue
	)

Definition at line 171 of file C4Scoreboard.cpp.

{
    // ensure primary row/col exists
    if (!iCols || !iRows)
    {
        if (!iCols) AddCol(0);
        if (!iRows) AddRow(0);
        GetCell(0, 0)->iVal = TitleKey;
    }
    // get row/col; create new if not yet existing
    int32_t iCol = GetColByKey(iColKey);
    if (iCol<0) { AddCol(iCol=iCols); GetCell(iCol, 0)->iVal = iColKey; }
    int32_t iRow = GetRowByKey(iRowKey);
    if (iRow<0) { AddRow(iRow=iRows); GetCell(0, iRow)->iVal = iRowKey; }
    // now set values
    Entry *pCell = GetCell(iCol, iRow);
    pCell->Text.Copy(szValue);
    if (iCol && iRow) pCell->iVal = iValue; // do NOT overwrite index keys!
    // if an empty value was set, prune empty
    if (!szValue || !*szValue)
    {
        // prune empty row (not label row)
        int32_t i;
        if (iRow)
        {
            for (i=1; i<iCols; ++i) if (GetCell(i, iRow)->Text) break;
            if (i == iCols) DelRow(iRow);
        }
        // prune empty col (not label col)
        if (iCol)
        {
            for (i=1; i<iRows; ++i) if (GetCell(iCol, i)->Text) break;
            if (i == iRows) DelCol(iCol);
        }
    }
    /*  // prune empty board? but this would prevent boards that just sort
      if (iRows == 1 && iCols == 1)
        Clear(); // must not do this, because it will del pDlg
      else*/
    // recalc row widths in display (else done by clear)
    InvalidateRows();
}

References GetCell(), and TitleKey.

Here is the call graph for this function:

ShouldBeShown()

bool C4Scoreboard::ShouldBeShown ( )

inline

Definition at line 83 of file C4Scoreboard.h.

{ return iDlgShow>0 && iRows && iCols; }

References iDlgShow.

Referenced by DoDlgShow().

Here is the caller graph for this function:

SortBy()

bool C4Scoreboard::SortBy	(	int32_t	iColKey,
		bool	fReverse
	)

Definition at line 250 of file C4Scoreboard.cpp.

{
    // get sort col
    int32_t iCol = GetColByKey(iColKey);
    if (iCol<0) return false;
    // sort
    int32_t iSortDir = fReverse ? -1 : +1;
    int32_t iSortBegin=1, iSortEnd=iRows-1;
    while (iSortBegin < iSortEnd)
    {
        int32_t iNewBorder = iSortBegin; int32_t i;
        for (i = iSortBegin; i < iSortEnd; ++i)
            if (GetCell(iCol, i)->iVal * iSortDir > GetCell(iCol, i+1)->iVal * iSortDir)
            {
                SwapRows(i, i+1);
                iNewBorder = i;
            }
        iSortEnd = iNewBorder;
        for (i = iSortEnd; i > iSortBegin; --i)
            if (GetCell(iCol, i-1)->iVal * iSortDir > GetCell(iCol, i)->iVal * iSortDir)
            {
                SwapRows(i-1, i);
                iNewBorder = i;
            }
        iSortBegin = iNewBorder;
    }
    return true;
}

References GetCell().

Here is the call graph for this function:

Friends And Related Function Documentation

C4ScoreboardDlg

friend class C4ScoreboardDlg

friend

Definition at line 66 of file C4Scoreboard.h.

Member Data Documentation

iDlgShow

int32_t C4Scoreboard::iDlgShow {0}

protected

Definition at line 61 of file C4Scoreboard.h.

Referenced by CanBeShown(), Clear(), CompileFunc(), DoDlgShow(), and ShouldBeShown().

pDlg

class C4ScoreboardDlg* C4Scoreboard::pDlg {nullptr}

protected

Definition at line 60 of file C4Scoreboard.h.

Referenced by Clear(), DoDlgShow(), HideDlg(), and C4ScoreboardDlg::~C4ScoreboardDlg().

---

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

• C4Scoreboard.h
• C4Scoreboard.cpp