C4LangStringTable Class Reference

#include <C4LangStringTable.h>

Inheritance diagram for C4LangStringTable:

Collaboration diagram for C4LangStringTable:

Classes
class	NoSuchTranslation

Public Member Functions
	C4LangStringTable ()=default
const std::string &	Translate (const std::string &text) const
bool	HasTranslation (const std::string &text) const
void	ReplaceStrings (StdStrBuf &rBuf)
void	ReplaceStrings (const StdStrBuf &rBuf, StdStrBuf &rTarget)
void	AddRef ()
void	DelRef ()
const char *	GetFilePath () const
void	Clear ()
const char *	GetData () const
const StdStrBuf &	GetDataBuf () const
size_t	GetDataSize () const
bool	Load (C4Group &hGroup, const char *szFilename, const char *szLanguage=nullptr)
bool	Load (C4GroupSet &hGroupSet, const char *szFilename, const char *szLanguage=nullptr)
bool	GetLanguageString (const char *szLanguage, StdStrBuf &rTarget)

Static Public Member Functions
static C4LangStringTable &	GetSystemStringTable ()

Protected Member Functions
void	OnLoad () override
void	CopyFilePathFromGroup (const C4Group &hGroup)
void	FinishLoad (const StdStrBuf &, C4Group &hGroup)

Protected Attributes
StdCopyStrBuf	Data
StdCopyStrBuf	Filename
StdCopyStrBuf	FilePath

Detailed Description

Definition at line 23 of file C4LangStringTable.h.

Constructor & Destructor Documentation

C4LangStringTable()

C4LangStringTable::C4LangStringTable ( )

default

Member Function Documentation

AddRef()

void C4LangStringTable::AddRef ( )

inline

Definition at line 39 of file C4LangStringTable.h.

{ ++ref_count;  }

Referenced by C4ScriptHost::Load(), and C4ScriptHost::LoadData().

Here is the caller graph for this function:

Clear()

void C4ComponentHost::Clear ( )

inlineinherited

Definition at line 29 of file C4ComponentHost.h.

{ Data.Clear(); OnLoad(); }

References StdStrBuf::Clear(), C4ComponentHost::Data, and C4ComponentHost::OnLoad().

Referenced by C4Game::Clear(), C4Def::Clear(), C4ScriptHost::Clear(), C4Language::ClearLanguage(), C4Def::Default(), C4ComponentHost::Load(), and C4ComponentHost::~C4ComponentHost().

Here is the call graph for this function:

Here is the caller graph for this function:

CopyFilePathFromGroup()

void C4ComponentHost::CopyFilePathFromGroup ( const C4Group &  hGroup )

protectedinherited

Definition at line 120 of file C4ComponentHost.cpp.

{
    FilePath.Copy(Config.AtRelativePath(hGroup.GetFullName().getData()));
    FilePath.AppendBackslash();
    FilePath.Append(Filename);
}

References StdStrBuf::Append(), StdStrBuf::AppendBackslash(), C4Config::AtRelativePath(), Config, StdStrBuf::Copy(), C4ComponentHost::Filename, C4ComponentHost::FilePath, StdStrBuf::getData(), and C4Group::GetFullName().

Referenced by C4ComponentHost::FinishLoad(), and C4ComponentHost::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

DelRef()

void C4LangStringTable::DelRef ( )

inline

Definition at line 40 of file C4LangStringTable.h.

{ if (!--ref_count) delete this; }

Referenced by C4ScriptHost::Clear(), C4ScriptHost::Load(), C4Game::LoadAdditionalSystemGroup(), and C4ScriptHost::LoadData().

Here is the caller graph for this function:

FinishLoad()

void C4ComponentHost::FinishLoad ( const StdStrBuf &  name, C4Group &  hGroup  )

protectedinherited

Definition at line 99 of file C4ComponentHost.cpp.

{
    // Store actual filename
    hGroup.FindEntry(name.getData(), &Filename);
    CopyFilePathFromGroup(hGroup);
 
    if (Data.EnsureUnicode())
    {
        LogF("WARNING: File is not encoded as UTF-8 (%s)", FilePath.getData());
    }
    // Skip those stupid "zero width no-break spaces" (also known as Byte Order Marks)
    if (Data[0] == '\xEF' && Data[1] == '\xBB' && Data[2] == '\xBF')
    {
        Data.Move(3,Data.getSize()-3);
        Data.Shrink(3);
    }
    // Notify
    OnLoad();
}

References C4ComponentHost::CopyFilePathFromGroup(), C4ComponentHost::Data, StdStrBuf::EnsureUnicode(), C4ComponentHost::Filename, C4ComponentHost::FilePath, C4Group::FindEntry(), StdStrBuf::getData(), StdStrBuf::getSize(), LogF(), StdStrBuf::Move(), C4ComponentHost::OnLoad(), and StdStrBuf::Shrink().

Referenced by C4ComponentHost::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

GetData()

const char* C4ComponentHost::GetData ( ) const

inlineinherited

Definition at line 30 of file C4ComponentHost.h.

{ return Data.getData(); }

References C4ComponentHost::Data, and StdStrBuf::getData().

Referenced by C4Game::CompileRuntimeData(), C4RankSystem::Load(), C4ScenarioListLoader::Entry::Load(), C4Player::LoadRuntimeData(), C4ObjectInfoList::New(), and C4Game::OpenScenario().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDataBuf()

const StdStrBuf& C4ComponentHost::GetDataBuf ( ) const

inlineinherited

Definition at line 31 of file C4ComponentHost.h.

{ return Data; }

References C4ComponentHost::Data.

Referenced by C4Game::CompileRuntimeData(), C4Language::HasStringTable(), and C4ScriptHost::MakeScript().

Here is the caller graph for this function:

GetDataSize()

size_t C4ComponentHost::GetDataSize ( ) const

inlineinherited

Definition at line 32 of file C4ComponentHost.h.

{ return Data.getLength(); }

References C4ComponentHost::Data, and StdStrBuf::getLength().

Referenced by C4RankSystem::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFilePath()

const char* C4ComponentHost::GetFilePath ( ) const

inlineinherited

Definition at line 28 of file C4ComponentHost.h.

{ return FilePath.getData(); }

References C4ComponentHost::FilePath, and StdStrBuf::getData().

Referenced by C4ScriptHost::Load(), C4Player::LoadRuntimeData(), C4ScriptHost::ReloadScript(), and ReplaceStrings().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLanguageString()

bool C4ComponentHost::GetLanguageString ( const char *  szLanguage, StdStrBuf &  rTarget  )

inherited

Definition at line 127 of file C4ComponentHost.cpp.

{
    const char *cptr;
    // No good parameters
    if (!szLanguage || !Data) return false;
    // Search for two-letter language identifier in text body, i.e. "DE:"
    char langindex[4] = "";
    for (int clseg=0; SCopySegment(szLanguage ? szLanguage : "", clseg, langindex, ',', 2); clseg++)
    {
        SAppend(":",langindex);
        if ((cptr = SSearch(Data.getData(),langindex)))
        {
            // Return the according string
            int iEndPos = SCharPos('\r', cptr);
            if (iEndPos<0) iEndPos = SCharPos('\n', cptr);
            if (iEndPos<0) iEndPos = strlen(cptr);
            rTarget.Copy(cptr, iEndPos);
            return true;
        }
    }
    // Language string not found
    return false;
}

References StdStrBuf::Copy(), C4ComponentHost::Data, StdStrBuf::getData(), SAppend(), SCharPos(), SCopySegment(), and SSearch().

Referenced by C4DefList::Load(), C4ScenarioListLoader::Entry::Load(), and C4Game::OpenScenario().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSystemStringTable()

static C4LangStringTable& C4LangStringTable::GetSystemStringTable ( )

inlinestatic

Definition at line 48 of file C4LangStringTable.h.

{ return system_string_table; }

Referenced by C4Language::ClearLanguage(), C4Language::HasStringTable(), and LoadResStr().

Here is the caller graph for this function:

HasTranslation()

bool C4LangStringTable::HasTranslation

(

const std::string &

text

)

const

Definition at line 23 of file C4LangStringTable.cpp.

{
    if (strings.empty())
        PopulateStringTable();
    return strings.find(text) != strings.end();
}

References C4ScriptGuiWindowPropertyName::text.

Load() [1/2]

bool C4ComponentHost::Load ( C4Group &  hGroup, const char *  szFilename, const char *  szLanguage = nullptr  )

inherited

Definition at line 23 of file C4ComponentHost.cpp.

{
    // Clear any old stuff
    Clear();
    // Store filename
    if (fname)
        Filename.Copy(fname);
    // Load component - try all segmented filenames
    char strEntry[_MAX_FNAME_LEN];
    StdStrBuf strEntryWithLanguage;
    for (int iFilename = 0; SCopySegment(Filename.getData(), iFilename, strEntry, '|'); iFilename++)
    {
        // Try to insert all language codes provided into the filename
        char strCode[3] = "";
        for (int iLang = 0; SCopySegment(szLanguage ? szLanguage : "", iLang, strCode, ',', 2); iLang++)
        {
            // Insert language code
            strEntryWithLanguage.Format(strEntry, strCode);
            if (hGroup.LoadEntryString(strEntryWithLanguage, &Data))
            {
                FinishLoad(strEntryWithLanguage, hGroup);
                // Got it
                return true;
            }
            // Couldn't insert language code anyway - no point in trying other languages
            if (!SSearch(strEntry, "%s")) break;
        }
    }
    // Truncate any additional segments from stored filename
    SReplaceChar(Filename.getMData(), '|', 0);
    CopyFilePathFromGroup(hGroup);
    // Not loaded
    return false;
}

References _MAX_FNAME_LEN, C4ComponentHost::Clear(), StdStrBuf::Copy(), C4ComponentHost::CopyFilePathFromGroup(), C4ComponentHost::Data, C4ComponentHost::Filename, C4ComponentHost::FinishLoad(), StdStrBuf::Format(), StdStrBuf::getData(), StdStrBuf::getMData(), C4Group::LoadEntryString(), SCopySegment(), SReplaceChar(), and SSearch().

Referenced by C4Game::CompileRuntimeData(), C4Game::InitScriptEngine(), C4ScriptHost::Load(), C4ScenarioListLoader::Entry::Load(), C4Language::LoadComponentHost(), and C4Game::LoadScenarioComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

Load() [2/2]

bool C4ComponentHost::Load ( C4GroupSet &  hGroupSet, const char *  szFilename, const char *  szLanguage = nullptr  )

inherited

Definition at line 60 of file C4ComponentHost.cpp.

{
    // Clear any old stuff
    Clear();
    // Store filename
    if (fname)
        Filename.Copy(fname);
    // Load component - try all segmented filenames
    char strEntry[_MAX_FNAME_LEN];
    StdStrBuf strEntryWithLanguage;
    for (int iFilename = 0; SCopySegment(Filename.getData(), iFilename, strEntry, '|'); iFilename++)
    {
        // Try to insert all language codes provided into the filename
        char strCode[3] = "";
        for (int iLang = 0; SCopySegment(szLanguage ? szLanguage : "", iLang, strCode, ',', 2); iLang++)
        {
            // Insert language code
            strEntryWithLanguage.Format(strEntry, strCode);
            if (hGroupSet.LoadEntryString(strEntryWithLanguage, &Data))
            {
                C4Group *pGroup = hGroupSet.FindEntry(strEntryWithLanguage.getData());
                FinishLoad(strEntryWithLanguage, *pGroup);
                // Got it
                return true;
            }
            // Couldn't insert language code anyway - no point in trying other languages
            if (!SSearch(strEntry, "%s")) break;
        }
    }
    // Truncate any additional segments from stored filename
    SReplaceChar(Filename.getMData(), '|', 0);
    // for error message purposes, the first group failed to provide the desired file
    CopyFilePathFromGroup(*hGroupSet.GetGroup(0));
    // Not loaded
    return false;
}

References _MAX_FNAME_LEN, C4ComponentHost::Clear(), StdStrBuf::Copy(), C4ComponentHost::CopyFilePathFromGroup(), C4ComponentHost::Data, C4ComponentHost::Filename, C4GroupSet::FindEntry(), C4ComponentHost::FinishLoad(), StdStrBuf::Format(), StdStrBuf::getData(), C4GroupSet::GetGroup(), StdStrBuf::getMData(), C4GroupSet::LoadEntryString(), SCopySegment(), SReplaceChar(), and SSearch().

Here is the call graph for this function:

OnLoad()

void C4LangStringTable::OnLoad ( )

inlineoverrideprotectedvirtual

Reimplemented from C4ComponentHost.

Definition at line 50 of file C4LangStringTable.h.

{ strings.clear(); } // Make sure we re-populate when the string table is reloaded

ReplaceStrings() [1/2]

void C4LangStringTable::ReplaceStrings	(	const StdStrBuf &	rBuf,
		StdStrBuf &	rTarget
	)

Definition at line 91 of file C4LangStringTable.cpp.

{
    if (!rBuf.getLength())
    {
        return;
    }
    // grab char ptr from buf
    const char *Data = rBuf.getData();
 
    // Find Replace Positions
    int iScriptLen = SLen(Data);
    struct RP { const char *Pos; std::string String; unsigned int Len; RP *Next; } *pRPList = nullptr, *pRPListEnd = nullptr;
    for (const char *pPos = SSearch(Data, "$"); pPos; pPos = SSearch(pPos, "$"))
    {
        // Get name
        char szStringName[C4MaxName + 1];
        SCopyUntil(pPos, szStringName, '$', C4MaxName); pPos += SLen(szStringName) + 1;
        if (*(pPos-1) != '$') continue;
        // valid?
        const char *pPos2 = szStringName;
        while (*pPos2)
            if (!IsIdentifier(*(pPos2++)))
                break;
        if (*pPos2) continue;
        // check termination
        try
        {
            // search in string table
            std::string pStrTblEntry = Translate(szStringName);
            // add new replace-position entry
            RP *pnRP = new RP;
            pnRP->Pos = pPos - SLen(szStringName) - 2;
            pnRP->String = pStrTblEntry;
            pnRP->Len = SLen(szStringName) + 2;
            pnRP->Next = nullptr;
            pRPListEnd = (pRPListEnd ? pRPListEnd->Next : pRPList) = pnRP;
            // calculate new script length
            iScriptLen += pStrTblEntry.size() - pnRP->Len;
        }
        catch (NoSuchTranslation &)
        {
            LogF(R"(%s: string table entry not found: "%s")", GetFilePath() ? GetFilePath() : "<unknown>", szStringName);
        }
    }
    // Alloc new Buffer
    char *pNewBuf;
    StdStrBuf sNewBuf;
    sNewBuf.SetLength(iScriptLen);
    pNewBuf = sNewBuf.getMData();
    // Copy data
    const char *pRPos = Data; char *pWPos = pNewBuf;
    for (RP *pRPPos = pRPList; pRPPos; pRPPos = pRPPos->Next)
    {
        // copy preceding string data
        SCopy(pRPos, pWPos, pRPPos->Pos - pRPos);
        pWPos += pRPPos->Pos - pRPos;
        // copy string
        SCopyUntil(pRPPos->String.c_str(), pWPos, '\n');
        SReplaceChar(pWPos, '\r', '\0');
        // advance
        pRPos = pRPPos->Pos + pRPPos->Len;
        pWPos += SLen(pWPos);
    }
    SCopy(pRPos, pWPos);
 
    while (pRPList)
    {
        RP *pRP = pRPList;
        pRPList = pRP->Next;
        delete pRP;
    }
 
    // assign this buf
    rTarget.Clear();
    rTarget.Take(std::move(sNewBuf));
}

References C4MaxName, StdStrBuf::Clear(), C4ComponentHost::Data, StdStrBuf::getData(), C4ComponentHost::GetFilePath(), StdStrBuf::getLength(), StdStrBuf::getMData(), IsIdentifier(), LogF(), SCopy(), SCopyUntil(), StdStrBuf::SetLength(), SLen(), SReplaceChar(), SSearch(), String(), StdStrBuf::Take(), and Translate().

Here is the call graph for this function:

ReplaceStrings() [2/2]

void C4LangStringTable::ReplaceStrings

(

StdStrBuf &

rBuf

)

Definition at line 168 of file C4LangStringTable.cpp.

{
    ReplaceStrings(rBuf, rBuf);
}

Referenced by C4MapFolderData::Load(), C4ScenarioParameterDefs::Load(), C4TeamList::Load(), C4PlayerControlFile::Load(), C4PlayerInfoList::Load(), C4ScriptHost::LoadData(), and C4ScriptHost::MakeScript().

Here is the caller graph for this function:

Translate()

const std::string & C4LangStringTable::Translate

(

const std::string &

text

)

const

Definition at line 30 of file C4LangStringTable.cpp.

{
    if (strings.empty())
        PopulateStringTable();
    Table::const_iterator it = strings.find(text);
    if (it == strings.end())
    {
        throw NoSuchTranslation(text);
    }
    return it->second;
}

References C4ScriptGuiWindowPropertyName::text.

Referenced by LoadResStr(), ReplaceStrings(), and C4ScriptHost::Translate().

Here is the caller graph for this function:

Member Data Documentation

Data

StdCopyStrBuf C4ComponentHost::Data

protectedinherited

Definition at line 41 of file C4ComponentHost.h.

Referenced by C4ComponentHost::Clear(), C4ComponentHost::FinishLoad(), C4ComponentHost::GetData(), C4ComponentHost::GetDataBuf(), C4ComponentHost::GetDataSize(), C4ComponentHost::GetLanguageString(), C4ComponentHost::Load(), and ReplaceStrings().

Filename

StdCopyStrBuf C4ComponentHost::Filename

protectedinherited

Definition at line 42 of file C4ComponentHost.h.

Referenced by C4ComponentHost::CopyFilePathFromGroup(), C4ComponentHost::FinishLoad(), and C4ComponentHost::Load().

FilePath

StdCopyStrBuf C4ComponentHost::FilePath

protectedinherited

Definition at line 43 of file C4ComponentHost.h.

Referenced by C4ComponentHost::CopyFilePathFromGroup(), C4ComponentHost::FinishLoad(), and C4ComponentHost::GetFilePath().

---

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

• C4LangStringTable.h
• C4Globals.cpp
• C4LangStringTable.cpp
• C4ScriptStandaloneStubs.cpp