C4GroupSet Class Reference

#include <C4GroupSet.h>

Collaboration diagram for C4GroupSet:

Public Member Functions
bool	UnregisterGroup (int32_t iIndex)
void	Clear ()
void	Default ()
	C4GroupSet ()
	C4GroupSet (const C4GroupSet &rCopy)
	~C4GroupSet ()
bool	RegisterGroup (C4Group &rGroup, bool fOwnGrp, int32_t Priority, int32_t Contents, bool fCheckContent=true)
bool	RegisterGroups (const C4GroupSet &rCopy, int32_t Contents, const char *szFilename=nullptr, int32_t iMaxSkipID=0)
C4Group *	FindGroup (int32_t Contents, C4Group *pAfter=nullptr, bool fSamePrio=false)
C4Group *	FindEntry (const char *szWildcard, int32_t *pPriority=nullptr, int32_t *pID=nullptr)
C4Group *	FindSuitableFile (const char *szName, const char *const extensions[], char *szFileName, int32_t *pID=nullptr)
int32_t	GetGroupCount ()
C4Group *	GetGroup (int32_t iIndex)
bool	LoadEntry (const char *szEntryName, char **lpbpBuf, size_t *ipSize=nullptr, int32_t iAppendZeros=0)
bool	LoadEntryString (const char *szEntryName, StdStrBuf *rBuf)
bool	LoadEntryString (const StdStrBuf &name, StdStrBuf *Buf)
C4Group *	RegisterParentFolders (const char *szScenFilename)
int32_t	PreCacheEntries (const char *szEntryMask)
int32_t	GetLastID ()
bool	CloseFolders ()

Static Public Member Functions
static int32_t	CheckGroupContents (C4Group &rGroup, int32_t Contents)

Protected Attributes
C4GroupSetNode *	pFirst
C4GroupSetNode *	pLast
int32_t	iIndex

Friends
class	C4GroupSetNode

Detailed Description

Definition at line 76 of file C4GroupSet.h.

Constructor & Destructor Documentation

C4GroupSet() [1/2]

C4GroupSet::C4GroupSet

(

)

Definition at line 66 of file C4GroupSet.cpp.

{
    // zero fields
    Default();
    iIndex=0;
}

References Default(), and iIndex.

Here is the call graph for this function:

C4GroupSet() [2/2]

C4GroupSet::C4GroupSet

(

const C4GroupSet &

rCopy

)

Definition at line 73 of file C4GroupSet.cpp.

{
    // zero fields
    Default();
    iIndex=0;
    // copy from other group set
    RegisterGroups(rCopy, C4GSCnt_All);
}

References C4GSCnt_All, Default(), iIndex, and RegisterGroups().

Here is the call graph for this function:

~C4GroupSet()

C4GroupSet::~C4GroupSet

(

)

Definition at line 82 of file C4GroupSet.cpp.

{
    // clear nodes
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

CheckGroupContents()

int32_t C4GroupSet::CheckGroupContents ( C4Group &  rGroup, int32_t  Contents  )

static

Definition at line 106 of file C4GroupSet.cpp.

{
    // update mask
    if (Contents & C4GSCnt_Graphics) if (!rGroup.FindEntry(C4CFN_Graphics)) Contents=Contents&~C4GSCnt_Graphics;
    if (Contents & C4GSCnt_Loaders)
    {
        if (!rGroup.FindEntry("Loader*.bmp")
            && !rGroup.FindEntry("Loader*.png")
            && !rGroup.FindEntry("Loader*.jpg")
            && !rGroup.FindEntry("Loader*.jpeg"))
        {
            Contents=Contents&~C4GSCnt_Loaders;
        }
    }
    if (Contents & C4GSCnt_Material) if (!rGroup.FindEntry(C4CFN_Material)) Contents=Contents&~C4GSCnt_Material;
    if (Contents & C4GSCnt_Music) if (!rGroup.FindEntry(C4CFN_Music)) Contents=Contents&~C4GSCnt_Music;
    if (Contents & C4GSCnt_Definitions) if (!rGroup.FindEntry(C4CFN_DefFiles)) Contents=Contents&~C4GSCnt_Definitions;
    if (Contents & C4GSCnt_FontDefs) if (!rGroup.FindEntry(C4CFN_FontFiles)) Contents=Contents&~C4GSCnt_FontDefs;
    // return it
    return Contents;
}

References C4CFN_DefFiles, C4CFN_FontFiles, C4CFN_Graphics, C4CFN_Material, C4CFN_Music, C4GSCnt_Definitions, C4GSCnt_FontDefs, C4GSCnt_Graphics, C4GSCnt_Loaders, C4GSCnt_Material, C4GSCnt_Music, and C4Group::FindEntry().

Referenced by C4GameResList::LoadFoldersWithLocalDefs(), and RegisterGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void C4GroupSet::Clear

(

)

Definition at line 50 of file C4GroupSet.cpp.

{
    // clear nodes
    while (pFirst) delete pFirst;
    pFirst = nullptr;
}

References pFirst.

Referenced by C4Language::Clear(), C4Game::Clear(), C4GraphicsResource::CloseFiles(), and ~C4GroupSet().

Here is the caller graph for this function:

CloseFolders()

bool C4GroupSet::CloseFolders

(

)

Definition at line 235 of file C4GroupSet.cpp.

{
    // close everything that has folder-priority
    for (C4GroupSetNode *pNode=pFirst,*pNext; pNode; pNode=pNext)
    {
        // get next, as pNode might be destroyed
        pNext=pNode->pNext;
        // check if priority matches
        if (Inside<int32_t>(pNode->Priority, C4GSPrio_Folder, C4GSPrio_Folder2) || pNode->Priority==C4GSPrio_Scenario)
            // clear it!
            delete pNode;
    }
    // done, success
    return true;
}

References C4GSPrio_Folder, C4GSPrio_Folder2, C4GSPrio_Scenario, and pFirst.

Referenced by C4Game::CloseScenario().

Here is the caller graph for this function:

Default()

void C4GroupSet::Default

(

)

Definition at line 57 of file C4GroupSet.cpp.

{
    // zero fields
    pFirst=pLast=nullptr;
    // do not reset index here, because group set IDs are meant to be unique
    // for each instance of the engine
    // see also C4GraphicsResource::RegisterGlobalGraphics
}

References pFirst, and pLast.

Referenced by C4GroupSet(), and C4Game::Default().

Here is the caller graph for this function:

FindEntry()

C4Group * C4GroupSet::FindEntry	(	const char *	szWildcard,
		int32_t *	pPriority = nullptr,
		int32_t *	pID = nullptr
	)

Definition at line 175 of file C4GroupSet.cpp.

{
    // find group that has this entry
    for (C4GroupSetNode *pNode=pFirst; pNode; pNode=pNode->pNext)
        if (pNode->pGroup->FindEntry(szWildcard))
        {
            // assign priority and ID, if ptrs is given
            if (pPriority) *pPriority=pNode->Priority;
            if (pID) *pID=pNode->id;
            // return found group
            return pNode->pGroup;
        }
    // nothing found
    return nullptr;
}

References pFirst, and C4GroupSetNode::pNext.

Referenced by FindSuitableFile(), C4AchievementGraphics::Init(), C4ComponentHost::Load(), C4Surface::LoadAny(), LoadEntry(), and LoadEntryString().

Here is the caller graph for this function:

FindGroup()

C4Group * C4GroupSet::FindGroup	(	int32_t	Contents,
		C4Group *	pAfter = nullptr,
		bool	fSamePrio = false
	)

Definition at line 155 of file C4GroupSet.cpp.

{
    // get priority
    int32_t iPriority=-1;
    // find group by matching content mask
    for (C4GroupSetNode *pNode=pFirst; pNode; pNode=pNode->pNext)
    {
        // check contents
        if (!pAfter && (pNode->Contents & Contents))
            // check priority
            if (iPriority==-1 || iPriority==pNode->Priority)
                // success, found an entry
                return pNode->pGroup;
        // find next clear flag
        if (pNode->pGroup == pAfter) { pAfter=nullptr; if (fSamePrio) iPriority=pNode->Priority; }
    }
    // nothing found
    return nullptr;
}

References pFirst, and C4GroupSetNode::pNext.

Referenced by C4LoaderScreen::Init(), C4MusicSystem::InitForScenario(), and C4GameResList::Load().

Here is the caller graph for this function:

FindSuitableFile()

C4Group * C4GroupSet::FindSuitableFile	(	const char *	szName,
		const char *const	extensions[],
		char *	szFileName,
		int32_t *	pID = nullptr
	)

Definition at line 191 of file C4GroupSet.cpp.

{
    C4Group *pGrp = nullptr;
    C4Group *pGrp2;
    int iPrio = -1;
    int32_t iPrio2;
    int32_t GroupID;
    char FileName[_MAX_FNAME];
    SCopy(szName, FileName);
    for (int i = 0; extensions[i]; ++i)
    {
        EnforceExtension(FileName, extensions[i]);
        pGrp2=FindEntry(FileName, &iPrio2, &GroupID);
        if ((!pGrp || iPrio2 >= iPrio) && pGrp2)
        {
            if (pID) *pID = GroupID;
            pGrp = pGrp2;
            SCopy(FileName, szFileName);
        }
    }
    // return found group, if any
    return pGrp;
}

References _MAX_FNAME, EnforceExtension(), FindEntry(), and SCopy().

Referenced by C4FontLoader::InitFont().

Here is the call graph for this function:

Here is the caller graph for this function:

GetGroup()

C4Group * C4GroupSet::GetGroup

(

int32_t

iIndex

)

Definition at line 259 of file C4GroupSet.cpp.

{
    // Invalid index
    if (iIndex < 0)
        return nullptr;
    // Find indicated group
    for (C4GroupSetNode *pNode = pFirst; pNode; pNode = pNode->pNext)
        if (iIndex == 0)
            return pNode->pGroup;
        else
            iIndex--;
    // Indicated group not found
    return nullptr;
}

References iIndex, pFirst, and C4GroupSetNode::pNext.

Referenced by C4Language::CloseGroup(), C4Language::GetPackGroups(), C4Language::Init(), and C4ComponentHost::Load().

Here is the caller graph for this function:

GetGroupCount()

int32_t C4GroupSet::GetGroupCount

(

)

Definition at line 251 of file C4GroupSet.cpp.

{
    int32_t iCount = 0;
    for (C4GroupSetNode *pNode = pFirst; pNode; pNode = pNode->pNext)
        iCount++;
    return iCount;
}

References pFirst, and C4GroupSetNode::pNext.

Referenced by C4Language::GetPackCount().

Here is the caller graph for this function:

GetLastID()

int32_t C4GroupSet::GetLastID ( )

inline

Definition at line 105 of file C4GroupSet.h.

{ return iIndex; } // return ID assigned to the last added group

References iIndex.

Referenced by C4GraphicsResource::RegisterMainGroups().

Here is the caller graph for this function:

LoadEntry()

bool C4GroupSet::LoadEntry	(	const char *	szEntryName,
		char **	lpbpBuf,
		size_t *	ipSize = nullptr,
		int32_t	iAppendZeros = 0
	)

Definition at line 215 of file C4GroupSet.cpp.

{
    // Load the entry from the first group that has it
    C4Group *pGroup;
    if ((pGroup = FindEntry(szEntryName)))
        return pGroup->LoadEntry(szEntryName, lpbpBuf, ipSize, iAppendZeros);
    // Didn't find it
    return false;
}

References FindEntry(), and C4Group::LoadEntry().

Here is the call graph for this function:

LoadEntryString() [1/2]

bool C4GroupSet::LoadEntryString	(	const char *	szEntryName,
		StdStrBuf *	rBuf
	)

Definition at line 225 of file C4GroupSet.cpp.

{
    // Load the entry from the first group that has it
    C4Group *pGroup;
    if ((pGroup = FindEntry(szEntryName)))
        return pGroup->LoadEntryString(szEntryName, rBuf);
    // Didn't find it
    return false;
}

References FindEntry(), and C4Group::LoadEntryString().

Referenced by C4ComponentHost::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadEntryString() [2/2]

bool C4GroupSet::LoadEntryString ( const StdStrBuf &  name, StdStrBuf *  Buf  )

inline

Definition at line 100 of file C4GroupSet.h.

{ return LoadEntryString(name.getData(), Buf); }

References StdStrBuf::getData(), and LoadEntryString().

Referenced by LoadEntryString().

Here is the call graph for this function:

Here is the caller graph for this function:

PreCacheEntries()

int32_t C4GroupSet::PreCacheEntries

(

const char *

szEntryMask

)

Definition at line 375 of file C4GroupSet.cpp.

{
    // pre-cache all entries matching mask for packed files in all groups
    // note this does not catch overloads.
    int32_t result = 0;
    for (C4GroupSetNode *pNode = pFirst; pNode; pNode = pNode->pNext)
        if (pNode->pGroup) result += pNode->pGroup->PreCacheEntries(szEntryMask);
    return result;
}

References pFirst, and C4GroupSetNode::pNext.

Referenced by C4GraphicsResource::Init().

Here is the caller graph for this function:

RegisterGroup()

bool C4GroupSet::RegisterGroup	(	C4Group &	rGroup,
		bool	fOwnGrp,
		int32_t	Priority,
		int32_t	Contents,
		bool	fCheckContent = true
	)

Definition at line 88 of file C4GroupSet.cpp.

{
    // get node to sort in
    // begin at back end and search for higher priority
    C4GroupSetNode *pNode;
    for (pNode=pLast; pNode; pNode=pNode->pPrev)
        if (pNode->Priority > Priority) break;
    // create new node
    C4GroupSetNode *pNewNode = new C4GroupSetNode(*this, pNode, rGroup, fOwnGrp, ++iIndex);
    // check content
    if (fCheckContent) Contents = CheckGroupContents(rGroup, Contents);
    // set priority and contents mask
    pNewNode->Priority = Priority;
    pNewNode->Contents = Contents;
 
    return true;
}

References C4GroupSetNode, CheckGroupContents(), C4GroupSetNode::Contents, iIndex, pLast, C4GroupSetNode::pPrev, and C4GroupSetNode::Priority.

Referenced by C4Language::Init(), C4Extra::LoadDef(), C4Game::OpenScenario(), C4GraphicsResource::RegisterGlobalGraphics(), RegisterGroups(), and RegisterParentFolders().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterGroups()

bool C4GroupSet::RegisterGroups	(	const C4GroupSet &	rCopy,
		int32_t	Contents,
		const char *	szFilename = nullptr,
		int32_t	iMaxSkipID = 0
	)

Definition at line 128 of file C4GroupSet.cpp.

{
    // get all groups of rCopy
    int32_t Contents2;
    for (C4GroupSetNode *pNode=rCopy.pFirst; pNode; pNode=pNode->pNext)
        if ((Contents2 = pNode->Contents & Contents))
            if (pNode->id > iMaxSkipID)
            {
                if (!szFilename)
                    // add group but don't check the content again!
                    RegisterGroup(*pNode->pGroup, false, pNode->Priority, Contents2, false);
                else
                {
                    // if a filename is given, open the child group
                    C4Group *pGroup = new C4Group();
                    if (!pGroup->OpenAsChild(pNode->pGroup, szFilename))
                        { delete pGroup; continue; }
                    // add the child group to the local list; contents equal Contents2
                    // but this flag is not likely to be used
                    if (!RegisterGroup(*pGroup, true, pNode->Priority, Contents2, false))
                        delete pGroup;
                }
            }
    // done, success
    return true;
}

References C4Group::OpenAsChild(), pFirst, C4GroupSetNode::pNext, and RegisterGroup().

Referenced by C4GroupSet(), and C4GraphicsResource::RegisterMainGroups().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterParentFolders()

C4Group * C4GroupSet::RegisterParentFolders

(

const char *

szScenFilename

)

Definition at line 294 of file C4GroupSet.cpp.

{
    // the scenario filename may be a scenario or directly a group folder
    C4Group *pParentGroup=nullptr; bool fParentC4F;
    char szParentfolder[_MAX_PATH_LEN];
    if (SEqualNoCase(GetExtension(szScenFilename), "ocf"))
    {
        fParentC4F = true;
        SCopy(szScenFilename, szParentfolder, _MAX_PATH);
    }
    else
    {
        GetParentPath(szScenFilename,szParentfolder);
        fParentC4F = SEqualNoCase(GetExtension(szParentfolder), "ocf");
    }
    if (fParentC4F)
    {
        // replace all (back)slashes with zero-fields
        int32_t iOriginalLen=SLen(szParentfolder);
        for (int32_t i=0; i<iOriginalLen; ++i) if (szParentfolder[i]==DirectorySeparator || szParentfolder[i]=='/') szParentfolder[i]=0;
        // trace back until the file extension is no more .ocf
        int32_t iPos=iOriginalLen-1;
        while (iPos)
        {
            // ignore additional zero fields (double-backslashes)
            while (iPos && !szParentfolder[iPos]) --iPos;
            // break if end has been reached
            if (!iPos) break;
            // trace back until next zero field
            while (iPos && szParentfolder[iPos]) --iPos;
            // check extension of this folder
            if (!SEqualNoCase(GetExtension(szParentfolder+iPos+1), "ocf", 3)) break;
            // continue
        }
        // trace backwards, putting the (back)slashes in place again
        if (iPos)
        {
            szParentfolder[iPos+1+SLen(szParentfolder+iPos+1)]=szParentfolder[iPos]=DirectorySeparator;
            while (iPos--) if (!szParentfolder[iPos]) szParentfolder[iPos]=DirectorySeparator;
            ++iPos;
        }
        // trace forward again, opening all folders (iPos is 0 again)
        int32_t iGroupIndex=0;
        while (iPos<iOriginalLen)
        {
            // ignore additional zero-fields
            while (iPos<iOriginalLen && !szParentfolder[iPos]) ++iPos;
            // break if end has been reached
            if (iPos>=iOriginalLen) break;
            // open this folder
            C4Group *pGroup = new C4Group();
            if (pParentGroup)
            {
                if (!pGroup->OpenAsChild(pParentGroup, szParentfolder+iPos))
                {
                    LogFatal(FormatString("%s: %s", LoadResStr("IDS_PRC_FILENOTFOUND"), szParentfolder+iPos).getData());
                    delete pGroup; return nullptr;
                }
            }
            else if (!Reloc.Open(*pGroup, szParentfolder+iPos))
            {
                LogFatal(FormatString("%s: %s", LoadResStr("IDS_PRC_FILENOTFOUND"), szParentfolder+iPos).getData());
                delete pGroup; return nullptr;
            }
            // set this group as new parent
            pParentGroup=pGroup;
            // add to group set, if this is a true scenario folder
            int32_t iContentsMask;
            if (WildcardMatch(C4CFN_FolderFiles, pParentGroup->GetName()))
                iContentsMask = C4GSCnt_Folder;
            else
                iContentsMask = C4GSCnt_Directory;
            if (!RegisterGroup(*pParentGroup, true, C4GSPrio_Folder+iGroupIndex++, iContentsMask))
                { delete pParentGroup; LogFatal ("RegGrp: internal error"); return nullptr; }
            // advance by file name length
            iPos+=SLen(szParentfolder+iPos);
        }
    }
    return pParentGroup;
}

References _MAX_PATH, _MAX_PATH_LEN, C4CFN_FolderFiles, C4GSCnt_Directory, C4GSCnt_Folder, C4GSPrio_Folder, DirectorySeparator, FormatString(), GetExtension(), C4Group::GetName(), GetParentPath(), LoadResStr(), LogFatal(), C4Reloc::Open(), C4Group::OpenAsChild(), RegisterGroup(), Reloc, SCopy(), SEqualNoCase(), SLen(), and WildcardMatch().

Referenced by C4Game::OpenScenario().

Here is the call graph for this function:

Here is the caller graph for this function:

UnregisterGroup()

bool C4GroupSet::UnregisterGroup

(

int32_t

iIndex

)

Definition at line 274 of file C4GroupSet.cpp.

{
    // Invalid index
    if (iIndex < 0)
        return false;
    // Find indicated group
    for (C4GroupSetNode *pNode = pFirst; pNode; pNode = pNode->pNext)
        if (iIndex == 0)
        {
            // Delete found node
            delete pNode;
            return true;
        }
        else
            iIndex--;
    // Indicated group not found
    return false;
 
}

References iIndex, pFirst, and C4GroupSetNode::pNext.

Referenced by C4Language::CloseGroup().

Here is the caller graph for this function:

Friends And Related Function Documentation

C4GroupSetNode

friend class C4GroupSetNode

friend

Definition at line 109 of file C4GroupSet.h.

Referenced by RegisterGroup().

Member Data Documentation

iIndex

int32_t C4GroupSet::iIndex

protected

Definition at line 80 of file C4GroupSet.h.

Referenced by C4GroupSet(), GetGroup(), GetLastID(), RegisterGroup(), and UnregisterGroup().

pFirst

C4GroupSetNode* C4GroupSet::pFirst

protected

Definition at line 79 of file C4GroupSet.h.

Referenced by C4GroupSetNode::C4GroupSetNode(), Clear(), CloseFolders(), Default(), FindEntry(), FindGroup(), GetGroup(), GetGroupCount(), PreCacheEntries(), RegisterGroups(), UnregisterGroup(), and C4GroupSetNode::~C4GroupSetNode().

pLast

C4GroupSetNode * C4GroupSet::pLast

protected

Definition at line 79 of file C4GroupSet.h.

Referenced by C4GroupSetNode::C4GroupSetNode(), Default(), RegisterGroup(), and C4GroupSetNode::~C4GroupSetNode().

---

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

• C4GroupSet.h
• C4GroupSet.cpp