C4Language Class Reference

#include <C4Language.h>

Public Member Functions
	C4Language ()
	~C4Language ()
bool	CloseGroup (const char *strPath)
void	ClearLanguage ()
bool	Init ()
void	Clear ()
int	GetPackCount ()
C4GroupSet	GetPackGroups (C4Group &)
int	GetInfoCount ()
C4LanguageInfo *	GetInfo (int iIndex)
C4LanguageInfo *	FindInfo (const char *strCode)
bool	LoadLanguage (const char *strLanguages)
bool	HasStringTable () const

Static Public Member Functions
static bool	LoadComponentHost (C4ComponentHost *host, C4Group &hGroup, const char *szFilename, const char *szLanguage)

Detailed Description

Definition at line 40 of file C4Language.h.

Constructor & Destructor Documentation

C4Language()

C4Language::C4Language

(

)

Definition at line 44 of file C4Language.cpp.

{
    Infos = nullptr;
    PackGroupLocation[0] = 0;
}

~C4Language()

C4Language::~C4Language

(

)

Definition at line 50 of file C4Language.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4Language::Clear

(

)

Definition at line 114 of file C4Language.cpp.

{
    // Clear pack groups
    PackGroups.Clear();
    // Clear packs
    Packs.Clear();
    // Close pack directory
    PackDirectory.Close();
    // Clear infos
    C4LanguageInfo* pNext;
    while (Infos)
    {
        pNext = Infos->Next;
        delete Infos;
        Infos = pNext;
    }
    Infos = nullptr;
}

References C4GroupSet::Clear(), and C4Group::Close().

Referenced by C4Application::Clear(), Init(), and ~C4Language().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearLanguage()

void C4Language::ClearLanguage

(

)

Definition at line 410 of file C4Language.cpp.

{
    // Clear resource string table
    C4LangStringTable::GetSystemStringTable().Clear();
}

References C4ComponentHost::Clear(), and C4LangStringTable::GetSystemStringTable().

Referenced by C4Application::Clear(), and LoadLanguage().

Here is the call graph for this function:

Here is the caller graph for this function:

CloseGroup()

bool C4Language::CloseGroup

(

const char *

strPath

)

Definition at line 418 of file C4Language.cpp.

{
    // Check all open language packs
    C4Group *pPack;
    for (int iPack = 0; (pPack = Packs.GetGroup(iPack)); iPack++)
        if (ItemIdentical(strPath, pPack->GetFullName().getData()))
        {
            Packs.UnregisterGroup(iPack);
            return true;
        }
    // No pack of that path
    return false;
}

References StdStrBuf::getData(), C4Group::GetFullName(), C4GroupSet::GetGroup(), ItemIdentical(), and C4GroupSet::UnregisterGroup().

Here is the call graph for this function:

FindInfo()

C4LanguageInfo * C4Language::FindInfo

(

const char *

strCode

)

Definition at line 353 of file C4Language.cpp.

{
    for (C4LanguageInfo *pInfo = Infos; pInfo; pInfo = pInfo->Next)
        if (SEqualNoCase(pInfo->Code, strCode, 2))
            return pInfo;
    return nullptr;
}

References C4LanguageInfo::Code, and SEqualNoCase().

Here is the call graph for this function:

GetInfo()

C4LanguageInfo * C4Language::GetInfo

(

int

iIndex

)

Definition at line 343 of file C4Language.cpp.

{
    for (C4LanguageInfo *pInfo = Infos; pInfo; pInfo = pInfo->Next)
        if (iIndex <= 0)
            return pInfo;
        else
            iIndex--;
    return nullptr;
}

GetInfoCount()

int C4Language::GetInfoCount

(

)

Definition at line 138 of file C4Language.cpp.

{
    int iCount = 0;
    for (C4LanguageInfo *pInfo = Infos; pInfo; pInfo = pInfo->Next)
        iCount++;
    return iCount;
}

GetPackCount()

int C4Language::GetPackCount

(

)

Definition at line 133 of file C4Language.cpp.

{
    return Packs.GetGroupCount();
}

References C4GroupSet::GetGroupCount().

Here is the call graph for this function:

GetPackGroups()

C4GroupSet C4Language::GetPackGroups

(

C4Group &

hGroup

)

Definition at line 148 of file C4Language.cpp.

{
    // Build a group set containing the provided group and
    // alternative groups for cross-loading from a language pack
    char strRelativePath[_MAX_PATH_LEN];
    char strTargetLocation[_MAX_PATH_LEN];
    char strPackPath[_MAX_PATH_LEN];
    char strPackGroupLocation[_MAX_PATH_LEN];
    char strAdvance[_MAX_PATH_LEN];
 
    // Store wanted target location
    SCopy(Config.AtRelativePath(hGroup.GetFullName().getData()), strRelativePath, _MAX_PATH);
    SCopy(strRelativePath, strTargetLocation, _MAX_PATH);
 
    // Adjust location by scenario origin
    if (Game.C4S.Head.Origin.getLength() && SEqualNoCase(GetExtension(Game.C4S.Head.Origin.getData()), "ocs"))
    {
        const char *szScenarioRelativePath = GetRelativePathS(strRelativePath, Config.AtRelativePath(Game.ScenarioFilename));
        if (szScenarioRelativePath != strRelativePath)
        {
            // this is a path within the scenario! Change to origin.
            size_t iRestPathLen = SLen(szScenarioRelativePath);
            if (Game.C4S.Head.Origin.getLength() + 1 + iRestPathLen <= _MAX_PATH)
            {
                SCopy(Game.C4S.Head.Origin.getData(), strTargetLocation);
                if (iRestPathLen)
                {
                    SAppendChar(DirectorySeparator, strTargetLocation);
                    SAppend(szScenarioRelativePath, strTargetLocation);
                }
            }
        }
    }
 
    // Process all language packs (and their respective pack groups)
    C4Group *pPack, *pPackGroup;
    for (int iPack = 0; (pPack = Packs.GetGroup(iPack)) && (pPackGroup = PackGroups.GetGroup(iPack)); iPack++)
    {
        // Get current pack group position within pack
        SCopy(pPack->GetFullName().getData(), strPackPath, _MAX_PATH);
        GetRelativePath(pPackGroup->GetFullName().getData(), strPackPath, strPackGroupLocation);
 
        // Pack group is at correct position within pack: continue with next pack
        if (SEqualNoCase(strPackGroupLocation, strTargetLocation))
            continue;
 
        // Try to backtrack until we can reach the target location as a relative child
        while ( strPackGroupLocation[0]
                && !GetRelativePath(strTargetLocation, strPackGroupLocation, strAdvance)
                && pPackGroup->OpenMother() )
        {
            // Update pack group location
            GetRelativePath(pPackGroup->GetFullName().getData(), strPackPath, strPackGroupLocation);
        }
 
        // We can reach the target location as a relative child
        if (strPackGroupLocation[0] && GetRelativePath(strTargetLocation, strPackGroupLocation, strAdvance))
        {
            // Advance pack group to relative child
            pPackGroup->OpenChild(strAdvance);
        }
 
        // Cannot reach by advancing: need to close and reopen (rewinding group file)
        else
        {
            // Close pack group (if it is open at all)
            pPackGroup->Close();
            // Reopen pack group to relative position in language pack if possible
            pPackGroup->OpenAsChild(pPack, strTargetLocation);
        }
 
    }
 
    // Store new target location
    SCopy(strTargetLocation, PackGroupLocation, _MAX_FNAME);
 
    C4GroupSet r;
    // Provided group gets highest priority
    r.RegisterGroup(hGroup, false, 1000, C4GSCnt_Component);
    // register currently open pack groups
    r.RegisterGroups(PackGroups, C4GSCnt_Language);
    return r;
}

References _MAX_PATH, _MAX_PATH_LEN, C4Config::AtRelativePath(), C4Game::C4S, Config, DirectorySeparator, Game, StdStrBuf::getData(), GetExtension(), C4Group::GetFullName(), C4GroupSet::GetGroup(), StdStrBuf::getLength(), GetRelativePathS(), C4Scenario::Head, C4SHead::Origin, SAppend(), SAppendChar(), C4Game::ScenarioFilename, SCopy(), SEqualNoCase(), and SLen().

Referenced by LoadComponentHost().

Here is the call graph for this function:

Here is the caller graph for this function:

HasStringTable()

bool C4Language::HasStringTable ( ) const

inline

Definition at line 70 of file C4Language.h.

{ return !C4LangStringTable::GetSystemStringTable().GetDataBuf().isNull(); }

References C4ComponentHost::GetDataBuf(), C4LangStringTable::GetSystemStringTable(), and StdStrBuf::isNull().

Referenced by C4Game::Clear(), C4Application::Clear(), and C4Application::DoInit().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4Language::Init

(

)

Definition at line 55 of file C4Language.cpp.

{
    // Clear (to allow clean re-init)
    Clear();
 
    // Make sure Language.ocg is unpacked (TODO: This won't work properly if Language.ocg is in system data path)
    // Assume for now that Language.ocg is either at a writable location or unpacked already.
    // TODO: Use all Language.c4gs that we find, and merge them.
    // TODO: Use gettext instead?
    StdStrBuf langPath;
    C4Reloc::iterator iter;
    for(iter = Reloc.begin(); iter != Reloc.end(); ++iter)
    {
        langPath.Copy(iter->strBuf + DirSep + C4CFN_Languages);
        if(ItemExists(langPath.getData()))
        {
            if(DirectoryExists(langPath.getData()))
                break;
            if(C4Group_UnpackDirectory(langPath.getData()))
                break;
        }
    }
 
    // Break if no language.ocg found
    if(iter != Reloc.end())
    {
        // Look for available language packs in Language.ocg
        C4Group *pPack;
        char strPackFilename[_MAX_FNAME_LEN], strEntry[_MAX_FNAME_LEN];
        if (PackDirectory.Open(langPath.getData()))
        {
            while (PackDirectory.FindNextEntry("*.ocg", strEntry))
            {
                sprintf(strPackFilename, "%s" DirSep "%s", C4CFN_Languages, strEntry);
                pPack = new C4Group();
                if (pPack->Open(strPackFilename))
                {
                    Packs.RegisterGroup(*pPack, true, C4GSCnt_Language, false);
                }
                else
                {
                    delete pPack;
                }
            }
        }
 
        // Now create a pack group for each language pack (these pack groups are child groups
        // that browse along each pack to access requested data)
        for (int iPack = 0; (pPack = Packs.GetGroup(iPack)); iPack++)
            PackGroups.RegisterGroup(*(new C4Group), true, C4GSPrio_Base, C4GSCnt_Language);
    }
 
    // Load language infos by scanning string tables (the engine doesn't really need this at the moment)
    InitInfos();
 
    // Done
    return true;
}

References _MAX_FNAME_LEN, C4Reloc::begin(), C4CFN_Languages, C4Group_UnpackDirectory(), C4GSCnt_Language, C4GSPrio_Base, Clear(), StdStrBuf::Copy(), DirectoryExists(), DirSep, C4Reloc::end(), C4Group::FindNextEntry(), StdStrBuf::getData(), C4GroupSet::GetGroup(), ItemExists(), C4Group::Open(), C4GroupSet::RegisterGroup(), Reloc, sprintf, and C4Reloc::PathInfo::strBuf.

Referenced by C4Application::DoInit().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadComponentHost()

bool C4Language::LoadComponentHost ( C4ComponentHost *  host, C4Group &  hGroup, const char *  szFilename, const char *  szLanguage  )

static

Definition at line 232 of file C4Language.cpp.

{
    assert(host);
    if (!host) return false;
    C4GroupSet hGroups = ::Languages.GetPackGroups(hGroup);
    return host->Load(hGroups, szFilename, szLanguage);
}

References GetPackGroups(), Languages, and C4ComponentHost::Load().

Referenced by C4ScenarioListLoader::SubFolder::DoLoadContents(), C4MapFolderData::Load(), C4RankSystem::Load(), C4DefList::Load(), C4ScenarioListLoader::Entry::Load(), C4Game::LoadAdditionalSystemGroup(), C4ScenarioListLoader::Scenario::LoadCustomPre(), C4Game::OpenScenario(), and C4Game::UpdateLanguage().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadLanguage()

bool C4Language::LoadLanguage

(

const char *

strLanguages

)

Definition at line 361 of file C4Language.cpp.

{
    // Clear old string table
    ClearLanguage();
    // Try to load string table according to language sequence
    char strLanguageCode[2 + 1];
    for (int i = 0; SCopySegment(strLanguages, i, strLanguageCode, ',', 2, true); i++)
        if (InitStringTable(strLanguageCode))
            return true;
    // No matching string table found: hardcoded fallback to US
    if (InitStringTable("US"))
        return true;
    // No string table present: this is really bad
    Log("Error loading language string table.");
    return false;
}

References ClearLanguage(), Log(), and SCopySegment().

Referenced by C4Application::DoInit().

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:

• C4Language.h
• C4Language.cpp