C4DefScriptHost Class Reference

#include <C4ScriptHost.h>

Inheritance diagram for C4DefScriptHost:

Collaboration diagram for C4DefScriptHost:

Public Member Functions
	C4DefScriptHost ()
void	SetDef (C4Def *to_def)
bool	Parse () override
C4PropListStatic *	GetPropList () override
virtual bool	Delete ()
void	Clear ()
virtual bool	Load (C4Group &hGroup, const char *szFilename, const char *szLanguage, C4LangStringTable *pLocalTable)
bool	Load (C4Group &hGroup, const char *szFilename, const char *szLanguage=nullptr)
bool	Load (C4GroupSet &hGroupSet, const char *szFilename, const char *szLanguage=nullptr)
virtual bool	LoadData (const char *szFilename, const char *szData, class C4LangStringTable *pLocalTable)
void	Reg2List (C4AulScriptEngine *pEngine)
const C4PropListStatic *	GetPropList () const
const char *	GetScript () const
bool	IsReady ()
std::string	Translate (const std::string &text) const
bool	IsWarningEnabled (const char *pos, C4AulWarningId warning) const
const char *	GetFilePath () const
const char *	GetData () const
const StdStrBuf &	GetDataBuf () const
size_t	GetDataSize () const
bool	GetLanguageString (const char *szLanguage, StdStrBuf &rTarget)

Public Attributes
std::deque< C4ScriptHost * >	SourceScripts
StdCopyStrBuf	ScriptName

Protected Member Functions
void	Unreg ()
void	MakeScript ()
virtual bool	ReloadScript (const char *szPath, const char *szLanguage)
bool	Preparse ()
virtual void	UnLink ()
void	UnlinkOwnedFunctions ()
void	DeleteOwnedPropLists ()
void	Warn (const char *pMsg,...) GNUC_FORMAT_ATTRIBUTE_O
virtual void	AddEngineFunctions ()
void	CopyPropList (C4Set< C4Property > &from, C4PropListStatic *to)
bool	ResolveIncludes (C4DefList *rDefs)
bool	ResolveAppends (C4DefList *rDefs)
void	DoAppend (C4Def *def)
void	EnableWarning (const char *pos, C4AulWarningId warning, bool enable=true)
virtual void	OnLoad ()
void	CopyFilePathFromGroup (const C4Group &hGroup)
void	FinishLoad (const StdStrBuf &, C4Group &hGroup)

Protected Attributes
C4Def *	Def {nullptr}
C4AulScriptEngine *	Engine {nullptr}
C4ScriptHost *	Prev {nullptr}
C4ScriptHost *	Next {nullptr}
std::list< StdCopyStrBuf >	Includes
std::list< StdCopyStrBuf >	Appends
bool	Resolving
bool	IncludesResolved
StdStrBuf	Script
C4LangStringTable *	stringTable
C4Set< C4Property >	LocalValues
C4AulScriptState	State {ASS_NONE}
std::vector< C4Value >	ownedFunctions
std::vector< C4Value >	ownedPropLists
StdCopyStrBuf	Data
StdCopyStrBuf	Filename
StdCopyStrBuf	FilePath

Detailed Description

Definition at line 139 of file C4ScriptHost.h.

Constructor & Destructor Documentation

C4DefScriptHost()

C4DefScriptHost::C4DefScriptHost ( )

inline

Definition at line 142 of file C4ScriptHost.h.

: C4ScriptHost() { }

Member Function Documentation

AddEngineFunctions()

virtual void C4ScriptHost::AddEngineFunctions ( )

inlineprotectedvirtualinherited

Reimplemented in C4MapScriptHost.

Definition at line 83 of file C4ScriptHost.h.

{}; // add any engine functions specific to this script host

Referenced by C4ScriptHost::Preparse().

Here is the caller graph for this function:

Clear()

void C4ScriptHost::Clear ( )

inherited

Definition at line 49 of file C4ScriptHost.cpp.

{
    UnlinkOwnedFunctions();
    C4ComponentHost::Clear();
    ast.reset();
    Script.Clear();
    LocalValues.Clear();
    DeleteOwnedPropLists();
    SourceScripts.clear();
    SourceScripts.push_back(this);
    if (stringTable)
    {
        stringTable->DelRef();
        stringTable = nullptr;
    }
    // remove includes
    Includes.clear();
    Appends.clear();
    // reset flags
    State = ASS_NONE;
    enabledWarnings.clear();
}

References C4ScriptHost::Appends, ASS_NONE, C4ComponentHost::Clear(), StdStrBuf::Clear(), C4Set< T >::Clear(), C4ScriptHost::DeleteOwnedPropLists(), C4LangStringTable::DelRef(), C4ScriptHost::Includes, C4ScriptHost::LocalValues, C4ScriptHost::Script, C4ScriptHost::SourceScripts, C4ScriptHost::State, C4ScriptHost::stringTable, and C4ScriptHost::UnlinkOwnedFunctions().

Referenced by C4Def::C4Def(), C4MapScriptHost::Clear(), C4Def::Clear(), C4ExtraScriptHost::Clear(), C4GameScriptHost::Clear(), C4Def::Default(), C4Def::~C4Def(), and C4ScriptHost::~C4ScriptHost().

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:

CopyPropList()

void C4ScriptHost::CopyPropList ( C4Set< C4Property > &  from, C4PropListStatic *  to  )

protectedinherited

Definition at line 1690 of file C4AulParse.cpp.

{
    // append all funcs and local variable initializations
    const C4Property * prop = from.First();
    while (prop)
    {
        switch(prop->Value.GetType())
        {
        case C4V_Function:
            {
                C4AulScriptFunc * sf = prop->Value.getFunction()->SFunc();
                if (sf)
                {
                    C4AulScriptFunc *sfc;
                    if (sf->pOrgScript != this)
                        sfc = new C4AulScriptFunc(to, *sf);
                    else
                        sfc = sf;
                    sfc->SetOverloaded(to->GetFunc(sf->Name));
                    to->SetPropertyByS(prop->Key, C4VFunction(sfc));
                }
                else
                {
                    // engine function
                    to->SetPropertyByS(prop->Key, prop->Value);
                }
            }
            break;
        case C4V_PropList:
            {
                C4PropListStatic * p = prop->Value._getPropList()->IsStatic();
                assert(p);
                if (prop->Key != &::Strings.P[P_Prototype])
                    if (!p || p->GetParent() != to)
                    {
                        p = C4PropList::NewStatic(nullptr, to, prop->Key);
                        CopyPropList(prop->Value._getPropList()->Properties, p);
                    }
                to->SetPropertyByS(prop->Key, C4VPropList(p));
            }
            break;
        case C4V_Array: // FIXME: copy the array if necessary
        default:
            to->SetPropertyByS(prop->Key, prop->Value);
        }
        prop = from.Next(prop);
    }
}

References C4Value::_getPropList(), C4ScriptHost::C4AulScriptFunc, C4V_Array, C4V_Function, C4V_PropList, C4VFunction(), C4VPropList(), C4Set< T >::First(), C4PropList::GetFunc(), C4Value::getFunction(), C4PropListStatic::GetParent(), C4Value::GetType(), C4PropList::IsStatic(), C4Property::Key, C4AulFunc::Name, C4PropList::NewStatic(), C4Set< T >::Next(), C4StringTable::P, P_Prototype, C4AulScriptFunc::pOrgScript, C4AulScriptFunc::SetOverloaded(), C4PropList::SetPropertyByS(), C4AulFunc::SFunc(), Strings, and C4Property::Value.

Referenced by C4ScriptHost::Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

Delete()

virtual bool C4ScriptHost::Delete ( )

inlinevirtualinherited

Reimplemented in C4ExtraScriptHost.

Definition at line 44 of file C4ScriptHost.h.

{ return false; } // do NOT delete this - it's just a class member!

Referenced by C4AulScriptEngine::Clear().

Here is the caller graph for this function:

DeleteOwnedPropLists()

void C4ScriptHost::DeleteOwnedPropLists ( )

protectedinherited

Definition at line 120 of file C4ScriptHost.cpp.

{
    // delete all static proplists associated to this script host.
    // Note that just clearing the vector is not enough in case of
    // cyclic references.
    for (C4Value& value: ownedPropLists)
    {
        C4PropList* plist = value.getPropList();
        if (plist)
        {
            if (plist->Delete()) delete plist;
            else plist->Clear();
        }
    }
    ownedPropLists.clear();
}

References C4PropList::Clear(), C4PropList::Delete(), and C4ScriptHost::ownedPropLists.

Referenced by C4ScriptHost::Clear(), and C4ScriptHost::UnLink().

Here is the call graph for this function:

Here is the caller graph for this function:

DoAppend()

void C4ScriptHost::DoAppend ( C4Def *  def )

protectedinherited

Definition at line 28 of file C4AulLink.cpp.

{
    if (std::find(def->Script.SourceScripts.begin(), def->Script.SourceScripts.end(), this) == def->Script.SourceScripts.end())
    {
        def->Script.SourceScripts.push_back(this);
        if (!Includes.empty())
        {
            Warn("#appendto contains #include");
            // Try to fullfil #include, but it won't work properly: #appendtos
            // are always appended, but #includes are prepended to the script.
            def->Script.Includes.insert(def->Script.Includes.end(), Includes.begin(), Includes.end());
        }
 
    }
}

References C4ScriptHost::Includes, C4Def::Script, C4ScriptHost::SourceScripts, and C4ScriptHost::Warn().

Referenced by C4ScriptHost::ResolveAppends().

Here is the call graph for this function:

Here is the caller graph for this function:

EnableWarning()

void C4ScriptHost::EnableWarning ( const char *  pos, C4AulWarningId  warning, bool  enable = true  )

protectedinherited

Definition at line 1776 of file C4AulParse.cpp.

{
    auto entry = enabledWarnings.emplace(pos, decltype(enabledWarnings)::mapped_type{});
    if (entry.second)
    {
        // If there was no earlier entry for this position, copy the previous
        // warning state
        assert(entry.first != enabledWarnings.begin());
        auto previous = entry.first;
        --previous;
        entry.first->second = previous->second;
    }
    entry.first->second.set(static_cast<size_t>(warning), enable);
}

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 C4LangStringTable::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:

GetPropList() [1/2]

const C4PropListStatic* C4ScriptHost::GetPropList ( ) const

inlineinherited

Definition at line 52 of file C4ScriptHost.h.

{ return const_cast<C4ScriptHost*>(this)->GetPropList(); }

References C4ScriptHost::GetPropList().

Referenced by C4ScriptHost::GetPropList().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPropList() [2/2]

C4PropListStatic * C4DefScriptHost::GetPropList ( )

overridevirtual

Reimplemented from C4ScriptHost.

Definition at line 324 of file C4ScriptHost.cpp.

{ return Def; }

References Def.

GetScript()

const char* C4ScriptHost::GetScript ( ) const

inlineinherited

Definition at line 53 of file C4ScriptHost.h.

{ return Script.getData(); }

References StdStrBuf::getData(), and C4ScriptHost::Script.

Referenced by C4AulParseError::C4AulParseError(), C4AulScriptFunc::GetLineOfCode(), and C4AulScriptContext::ReturnDump().

Here is the call graph for this function:

Here is the caller graph for this function:

IsReady()

bool C4ScriptHost::IsReady ( )

inlineinherited

Definition at line 54 of file C4ScriptHost.h.

{ return State == ASS_PARSED; } // whether script calls may be done

References ASS_PARSED, and C4ScriptHost::State.

Referenced by C4GUI::FrameDecoration::SetByDef().

Here is the caller graph for this function:

IsWarningEnabled()

bool C4ScriptHost::IsWarningEnabled ( const char *  pos, C4AulWarningId  warning  ) const

inherited

Definition at line 1791 of file C4AulParse.cpp.

{
    assert(!enabledWarnings.empty());
    if (enabledWarnings.empty())
        return false;
    
    // find nearest set of warnings at or before the current position
    auto entry = enabledWarnings.upper_bound(pos);
    assert(entry != enabledWarnings.begin());
    if (entry != enabledWarnings.begin())
    {
        --entry;
    }
 
    return entry->second.test(static_cast<size_t>(warning));
}

Load() [1/3]

bool C4ScriptHost::Load ( C4Group &  hGroup, const char *  szFilename, const char *  szLanguage, C4LangStringTable *  pLocalTable  )

virtualinherited

Reimplemented in C4GameScriptHost, and C4MapScriptHost.

Definition at line 164 of file C4ScriptHost.cpp.

{
    // Base load
    bool fSuccess = C4ComponentHost::Load(hGroup,szFilename,szLanguage);
    // String Table
    if (stringTable != pLocalTable)
    {
        if (stringTable) stringTable->DelRef();
        stringTable = pLocalTable;
        if (stringTable) stringTable->AddRef();
    }
    // set name
    ScriptName.Ref(GetFilePath());
    // preparse script
    MakeScript();
    // Success
    return fSuccess;
}

References C4LangStringTable::AddRef(), C4LangStringTable::DelRef(), C4ComponentHost::GetFilePath(), C4ComponentHost::Load(), C4ScriptHost::MakeScript(), StdStrBuf::Ref(), C4ScriptHost::ScriptName, and C4ScriptHost::stringTable.

Referenced by C4Game::InitScriptEngine(), C4MapScriptHost::Load(), C4GameScriptHost::Load(), C4Def::Load(), C4Game::LoadAdditionalSystemGroup(), C4ScriptHost::ReloadScript(), and C4ScenarioSection::ScenarioLoad().

Here is the call graph for this function:

Here is the caller graph for this function:

Load() [2/3]

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() [3/3]

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:

LoadData()

bool C4ScriptHost::LoadData ( const char *  szFilename, const char *  szData, class C4LangStringTable *  pLocalTable  )

virtualinherited

Reimplemented in C4GameScriptHost, and C4MapScriptHost.

Definition at line 184 of file C4ScriptHost.cpp.

{
    // String Table
    if (stringTable != pLocalTable)
    {
        if (stringTable) stringTable->DelRef();
        stringTable = pLocalTable;
        if (stringTable) stringTable->AddRef();
    }
    ScriptName.Copy(szFilename);
 
    StdStrBuf tempScript;
    tempScript.Copy(szData);
 
    Script.Clear();
    if(stringTable)
        stringTable->ReplaceStrings(tempScript, Script);
    else
        Script.Take(tempScript);
 
    Preparse();
    return true;
}

References C4LangStringTable::AddRef(), StdStrBuf::Clear(), StdStrBuf::Copy(), C4LangStringTable::DelRef(), C4ScriptHost::Preparse(), C4LangStringTable::ReplaceStrings(), C4ScriptHost::Script, C4ScriptHost::ScriptName, C4ScriptHost::stringTable, and StdStrBuf::Take().

Referenced by C4MapScriptHost::LoadData(), and C4GameScriptHost::LoadData().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeScript()

void C4ScriptHost::MakeScript ( )

protectedinherited

Definition at line 208 of file C4ScriptHost.cpp.

{
    // clear prev
    Script.Clear();
 
    // create script
    if (stringTable)
    {
        stringTable->ReplaceStrings(GetDataBuf(), Script);
    }
    else
    {
        Script.Ref(GetDataBuf());
    }
 
    // preparse script
    Preparse();
}

References StdStrBuf::Clear(), C4ComponentHost::GetDataBuf(), C4ScriptHost::Preparse(), StdStrBuf::Ref(), C4LangStringTable::ReplaceStrings(), C4ScriptHost::Script, and C4ScriptHost::stringTable.

Referenced by C4ScriptHost::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

OnLoad()

virtual void C4ComponentHost::OnLoad ( )

inlineprotectedvirtualinherited

Reimplemented in C4LangStringTable.

Definition at line 39 of file C4ComponentHost.h.

{}

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

Here is the caller graph for this function:

Parse()

bool C4DefScriptHost::Parse ( )

overridevirtual

Reimplemented from C4ScriptHost.

Definition at line 283 of file C4ScriptHost.cpp.

{
    bool r = C4ScriptHost::Parse();
    assert(Def);
 
    // Check category
    if (!Def->GetPlane() && Def->Category & C4D_SortLimit)
    {
        int Plane; bool gotplane = true;
        switch (Def->Category & C4D_SortLimit)
        {
            case C4D_StaticBack: Plane = 100; break;
            case C4D_Structure: Plane = C4Plane_Structure; break;
            case C4D_Vehicle: Plane = 300; break;
            case C4D_Living: Plane = 400; break;
            case C4D_Object: Plane = 500; break;
            case C4D_StaticBack | C4D_Background: Plane = -500; break;
            case C4D_Structure | C4D_Background: Plane = -400; break;
            case C4D_Vehicle | C4D_Background: Plane = -300; break;
            case C4D_Living | C4D_Background: Plane = -200; break;
            case C4D_Object | C4D_Background: Plane = -100; break;
            case C4D_StaticBack | C4D_Foreground: Plane = 1100; break;
            case C4D_Structure | C4D_Foreground: Plane = 1200; break;
            case C4D_Vehicle | C4D_Foreground: Plane = 1300; break;
            case C4D_Living | C4D_Foreground: Plane = 1400; break;
            case C4D_Object | C4D_Foreground: Plane = 1500; break;
            default:
                Warn("Def %s (%s) has invalid category", Def->GetName(), Def->GetDataString().getData());
                gotplane = false;
                break;
        }
        if (gotplane) Def->SetProperty(P_Plane, C4VInt(Plane));
    }
    if (!Def->GetPlane())
    {
        Warn("Def %s (%s) has invalid Plane", Def->GetName(), Def->GetDataString().getData());
        Def->SetProperty(P_Plane, C4VInt(1));
    }
    return r;
}

References C4D_Background, C4D_Foreground, C4D_Living, C4D_Object, C4D_SortLimit, C4D_StaticBack, C4D_Structure, C4D_Vehicle, C4Plane_Structure, C4VInt(), C4Def::Category, Def, StdStrBuf::getData(), C4PropListStatic::GetDataString(), C4PropListStatic::GetName(), C4Def::GetPlane(), P_Plane, C4ScriptHost::Parse(), C4PropList::SetProperty(), and C4ScriptHost::Warn().

Here is the call graph for this function:

Preparse()

bool C4ScriptHost::Preparse ( )

protectedinherited

Definition at line 693 of file C4AulParse.cpp.

{
    // handle easiest case first
    if (State < ASS_NONE) return false;
 
    // clear stuff
    Includes.clear(); Appends.clear();
 
    GetPropList()->C4PropList::Clear();
    GetPropList()->SetProperty(P_Prototype, C4VPropList(Engine->GetPropList()));
    LocalValues.Clear();
 
    // Add any engine functions specific to this script
    AddEngineFunctions();
 
    // Insert default warnings
    assert(enabledWarnings.empty());
    auto &warnings = enabledWarnings[Script.getData()];
#define DIAG(id, text, enabled) warnings.set(static_cast<size_t>(C4AulWarningId::id), enabled);
#include "C4AulWarnings.h"
#undef DIAG
 
    C4AulParse parser(this);
    ast = parser.Parse_Script(this);
 
    C4AulCompiler::Preparse(this, this, ast.get());
 
    // #include will have to be resolved now...
    IncludesResolved = false;
 
    // Parse will write the properties back after the ones from included scripts
    GetPropList()->Properties.Swap(&LocalValues);
 
    // return success
    this->State = ASS_PREPARSED;
    return true;
}

References C4ScriptHost::AddEngineFunctions(), C4ScriptHost::Appends, ASS_NONE, ASS_PREPARSED, C4VPropList(), C4Set< T >::Clear(), C4ScriptHost::Engine, StdStrBuf::getData(), C4AulScriptEngine::GetPropList(), C4ScriptHost::GetPropList(), C4ScriptHost::Includes, C4ScriptHost::IncludesResolved, C4ScriptHost::LocalValues, P_Prototype, C4AulParse::Parse_Script(), C4AulCompiler::Preparse(), C4ScriptHost::Script, C4PropList::SetProperty(), and C4ScriptHost::State.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Reg2List()

void C4ScriptHost::Reg2List ( C4AulScriptEngine *  pEngine )

inherited

Definition at line 146 of file C4ScriptHost.cpp.

{
    // already regged? (def reloaded)
    if (Engine) return;
    // reg to list
    if ((Engine = pEngine))
    {
        if ((Prev = Engine->ChildL))
            Prev->Next = this;
        else
            Engine->Child0 = this;
        Engine->ChildL = this;
    }
    else
        Prev = nullptr;
    Next = nullptr;
}

References C4AulScriptEngine::Child0, C4AulScriptEngine::ChildL, C4ScriptHost::Engine, C4ScriptHost::Next, and C4ScriptHost::Prev.

Referenced by C4MapScriptHost::InitFunctionMap(), C4Game::InitScriptEngine(), C4GameScriptHost::Load(), C4Def::Load(), C4Game::LoadAdditionalSystemGroup(), C4GameScriptHost::LoadData(), and C4ScenarioSection::ScenarioLoad().

Here is the caller graph for this function:

ReloadScript()

bool C4ScriptHost::ReloadScript ( const char *  szPath, const char *  szLanguage  )

protectedvirtualinherited

Definition at line 227 of file C4ScriptHost.cpp.

{
    // this?
    if (SEqualNoCase(szPath, GetFilePath()) || (stringTable && SEqualNoCase(szPath, stringTable->GetFilePath())))
    {
        // try reload
        char szParentPath[_MAX_PATH_LEN]; C4Group ParentGrp;
        if (GetParentPath(szPath, szParentPath))
            if (ParentGrp.Open(szParentPath))
                if (Load(ParentGrp, nullptr, szLanguage, stringTable))
                    return true;
    }
    return false;
}

References _MAX_PATH_LEN, C4ComponentHost::GetFilePath(), GetParentPath(), C4ScriptHost::Load(), C4Group::Open(), SEqualNoCase(), and C4ScriptHost::stringTable.

Here is the call graph for this function:

ResolveAppends()

bool C4ScriptHost::ResolveAppends ( C4DefList *  rDefs )

protectedinherited

Definition at line 46 of file C4AulLink.cpp.

{
    // resolve local appends
    if (State != ASS_PREPARSED) return false;
    for (auto & Append : Appends)
    {
        if (Append != "*" || !rDefs)
        {
            C4Def *Def = rDefs ? rDefs->GetByName(Append) : nullptr;
            if (Def)
            {
                DoAppend(Def);
            }
            else
            {
                // save id in buffer because AulWarn will use the buffer of C4IdText
                // to get the id of the object in which the error occurs...
                // (stupid static buffers...)
                Warn("#appendto %s not found", Append.getData());
            }
        }
        else
        {
            // append to all defs
            for (int i = 0; i < rDefs->GetDefCount(); i++)
            {
                C4Def *pDef = rDefs->GetDef(i);
                if (!pDef) break;
                if (pDef == GetPropList()) continue;
                // append
                DoAppend(pDef);
            }
        }
    }
    return true;
}

References C4ScriptHost::Appends, ASS_PREPARSED, C4ScriptHost::DoAppend(), C4DefList::GetByName(), C4DefList::GetDef(), C4DefList::GetDefCount(), C4ScriptHost::GetPropList(), C4ScriptHost::State, and C4ScriptHost::Warn().

Here is the call graph for this function:

ResolveIncludes()

bool C4ScriptHost::ResolveIncludes ( C4DefList *  rDefs )

protectedinherited

Definition at line 83 of file C4AulLink.cpp.

{
    // Had been preparsed?
    if (State != ASS_PREPARSED) return false;
    // has already been resolved?
    if (IncludesResolved) return true;
    // catch circular includes
    if (Resolving)
    {
        Engine->GetErrorHandler()->OnError(C4AulParseError(this, "Circular include chain detected - ignoring all includes!").what());
        IncludesResolved = true;
        State = ASS_LINKED;
        return false;
    }
    Resolving=true;
    // append all includes to local script
    for (std::list<StdCopyStrBuf>::reverse_iterator i = Includes.rbegin(); i != Includes.rend(); ++i)
    {
        C4Def *Def = rDefs ? rDefs->GetByName(*i) : nullptr;
        if (Def)
        {
            // resolve #includes in included script first (#include-chains :( )
            if (!Def->Script.IncludesResolved)
                if (!Def->Script.ResolveIncludes(rDefs))
                    continue; // skip this #include
 
            for (auto s = Def->Script.SourceScripts.rbegin(); s != Def->Script.SourceScripts.rend(); ++s)
            {
                if (std::find(SourceScripts.begin(), SourceScripts.end(), *s) == SourceScripts.end())
                    SourceScripts.push_front(*s);
            }
        }
        else
        {
            // save id in buffer because AulWarn will use the buffer of C4IdText
            // to get the id of the object in which the error occurs...
            // (stupid static buffers...)
            Warn("#include %s not found", i->getData());
        }
    }
    IncludesResolved = true;
    // includes/appends are resolved now (for this script)
    Resolving=false;
    State = ASS_LINKED;
    return true;
}

References ASS_LINKED, ASS_PREPARSED, C4ScriptHost::Engine, C4DefList::GetByName(), C4AulScriptEngine::GetErrorHandler(), C4ScriptHost::Includes, C4ScriptHost::IncludesResolved, C4AulErrorHandler::OnError(), C4ScriptHost::ResolveIncludes(), C4ScriptHost::Resolving, s, C4Def::Script, C4ScriptHost::SourceScripts, C4ScriptHost::State, and C4ScriptHost::Warn().

Referenced by C4ScriptHost::ResolveIncludes().

Here is the call graph for this function:

Here is the caller graph for this function:

SetDef()

void C4DefScriptHost::SetDef ( C4Def *  to_def )

inline

Definition at line 144 of file C4ScriptHost.h.

{ Def=to_def; }

References Def.

Referenced by C4Def::C4Def().

Here is the caller graph for this function:

Translate()

std::string C4ScriptHost::Translate ( const std::string &  text ) const

inherited

Definition at line 242 of file C4ScriptHost.cpp.

{
    if (stringTable)
        return stringTable->Translate(text);
    throw C4LangStringTable::NoSuchTranslation(text);
}

References C4ScriptHost::stringTable, C4ScriptGuiWindowPropertyName::text, and C4LangStringTable::Translate().

Here is the call graph for this function:

UnLink()

void C4ScriptHost::UnLink ( )

protectedvirtualinherited

Definition at line 130 of file C4AulLink.cpp.

{
    C4PropList * p = GetPropList();
    if (p)
    {
        p->C4PropList::Clear();
        p->SetProperty(P_Prototype, C4VPropList(Engine->GetPropList()));
    }
 
    // Delete cyclic references of owned proplists
    DeleteOwnedPropLists();
 
    // includes will have to be re-resolved now
    IncludesResolved = false;
 
    if (State > ASS_PREPARSED) State = ASS_PREPARSED;
}

References ASS_PREPARSED, C4VPropList(), C4ScriptHost::DeleteOwnedPropLists(), C4ScriptHost::Engine, C4AulScriptEngine::GetPropList(), C4ScriptHost::GetPropList(), C4ScriptHost::IncludesResolved, P_Prototype, C4PropList::SetProperty(), and C4ScriptHost::State.

Here is the call graph for this function:

UnlinkOwnedFunctions()

void C4ScriptHost::UnlinkOwnedFunctions ( )

protectedinherited

Definition at line 72 of file C4ScriptHost.cpp.

{
    // Remove owned functions from their parents. This solves a problem
    // where overloading a definition would unload the C4ScriptHost, but
    // keep around global functions, which then contained dangling pointers.
    for (const auto &box : ownedFunctions)
    {
        assert(box.GetType() == C4V_Function);
        C4AulScriptFunc *func = box._getFunction()->SFunc();
        C4PropList *parent = func->Parent;
        if (parent == GetPropList())
            continue;
        assert(parent == &::ScriptEngine);
        C4Value v;
        parent->GetPropertyByS(func->Name, &v);
        if (v.getFunction() == func)
        {
            // If the function we're deleting is the top-level function in
            // the inheritance chain, promote the next one in its stead;
            // if there is no overloaded function, remove the property.
            parent->Thaw();
            if (func->OwnerOverloaded)
                parent->SetPropertyByS(func->Name, C4VFunction(func->OwnerOverloaded));
            else
                parent->ResetProperty(func->Name);
        }
        else
        {
            C4AulScriptFunc *func_chain = v.getFunction()->SFunc();
            assert(func_chain != func);
            while (func_chain)
            {
                // Unlink the removed function from the inheritance chain
                if (func_chain->OwnerOverloaded == func)
                {
                    func_chain->OwnerOverloaded = func->OwnerOverloaded;
                    func->OwnerOverloaded = nullptr; // func_chain now takes care of this.
                    func->DecRef(); // decrease rc because func_chain no longer has a reference to func.
                    break;
                }
                assert(func_chain->OwnerOverloaded && "Removed function not found in inheritance chain");
                func_chain = func_chain->OwnerOverloaded->SFunc();
            }
        }
    }
    ownedFunctions.clear();
}

References C4V_Function, C4VFunction(), C4RefCnt::DecRef(), C4Value::getFunction(), C4PropList::GetPropertyByS(), C4ScriptHost::GetPropList(), C4AulFunc::Name, C4ScriptHost::ownedFunctions, C4AulScriptFunc::OwnerOverloaded, C4AulFunc::Parent, C4PropList::ResetProperty(), ScriptEngine, C4PropList::SetPropertyByS(), C4AulFunc::SFunc(), C4AulScriptFunc::SFunc(), and C4PropList::Thaw().

Referenced by C4ScriptHost::Clear().

Here is the call graph for this function:

Here is the caller graph for this function:

Unreg()

void C4ScriptHost::Unreg ( )

protectedinherited

Definition at line 137 of file C4ScriptHost.cpp.

{
    // remove from list
    if (Prev) Prev->Next = Next; else if (Engine) Engine->Child0 = Next;
    if (Next) Next->Prev = Prev; else if (Engine) Engine->ChildL = Prev;
    Prev = Next = nullptr;
    Engine = nullptr;
}

References C4AulScriptEngine::Child0, C4AulScriptEngine::ChildL, C4ScriptHost::Engine, C4ScriptHost::Next, and C4ScriptHost::Prev.

Referenced by C4AulScriptEngine::Clear(), and C4ScriptHost::~C4ScriptHost().

Here is the caller graph for this function:

Warn()

void C4ScriptHost::Warn ( const char *  pMsg,   ...  )

protectedinherited

Definition at line 124 of file C4AulParse.cpp.

{
    va_list args; va_start(args, pMsg);
    StdStrBuf Buf = FormatStringV(pMsg, args);
    Buf.AppendFormat(" (%s)", ScriptName.getData());
    Engine->GetErrorHandler()->OnWarning(Buf.getData());
    va_end(args);
}

References StdStrBuf::AppendFormat(), C4ScriptHost::Engine, FormatStringV(), StdStrBuf::getData(), C4AulScriptEngine::GetErrorHandler(), C4AulErrorHandler::OnWarning(), and C4ScriptHost::ScriptName.

Referenced by C4ScriptHost::DoAppend(), Parse(), C4ScriptHost::ResolveAppends(), and C4ScriptHost::ResolveIncludes().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Appends

std::list<StdCopyStrBuf> C4ScriptHost::Appends

protectedinherited

Definition at line 81 of file C4ScriptHost.h.

Referenced by C4ScriptHost::C4ScriptHost(), C4ScriptHost::Clear(), C4ScriptHost::Parse(), C4ScriptHost::Preparse(), C4ScriptHost::ResolveAppends(), and C4AulCompiler::PreparseAstVisitor::visit().

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 C4LangStringTable::ReplaceStrings().

Def

C4Def* C4DefScriptHost::Def {nullptr}

protected

Definition at line 148 of file C4ScriptHost.h.

Referenced by GetPropList(), Parse(), and SetDef().

Engine

C4AulScriptEngine* C4ScriptHost::Engine {nullptr}

protectedinherited

Definition at line 77 of file C4ScriptHost.h.

Referenced by C4AulCompiler::ConstexprEvaluator::eval(), C4AulCompiler::ConstexprEvaluator::eval_static(), C4ScriptHost::Parse(), C4ScriptHost::Preparse(), C4ScriptHost::Reg2List(), C4ScriptHost::ResolveIncludes(), C4ScriptHost::UnLink(), C4ScriptHost::Unreg(), C4AulCompiler::PreparseAstVisitor::visit(), C4AulCompiler::ConstexprEvaluator::visit(), C4AulCompiler::ConstantResolver::visit(), and C4ScriptHost::Warn().

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().

Includes

std::list<StdCopyStrBuf> C4ScriptHost::Includes

protectedinherited

Definition at line 80 of file C4ScriptHost.h.

Referenced by C4ScriptHost::C4ScriptHost(), C4ScriptHost::Clear(), C4ScriptHost::DoAppend(), C4ScriptHost::Preparse(), C4ScriptHost::ResolveIncludes(), and C4AulCompiler::PreparseAstVisitor::visit().

IncludesResolved

bool C4ScriptHost::IncludesResolved

protectedinherited

Definition at line 89 of file C4ScriptHost.h.

Referenced by C4ScriptHost::C4ScriptHost(), C4ScriptHost::Preparse(), C4ScriptHost::ResolveIncludes(), and C4ScriptHost::UnLink().

LocalValues

C4Set<C4Property> C4ScriptHost::LocalValues

protectedinherited

Definition at line 93 of file C4ScriptHost.h.

Referenced by C4ScriptHost::Clear(), and C4ScriptHost::Preparse().

Next

C4ScriptHost * C4ScriptHost::Next {nullptr}

protectedinherited

Definition at line 78 of file C4ScriptHost.h.

Referenced by C4ScriptHost::Reg2List(), and C4ScriptHost::Unreg().

ownedFunctions

std::vector<C4Value> C4ScriptHost::ownedFunctions

protectedinherited

Definition at line 97 of file C4ScriptHost.h.

Referenced by C4ScriptHost::UnlinkOwnedFunctions(), and C4AulCompiler::PreparseAstVisitor::visit().

ownedPropLists

std::vector<C4Value> C4ScriptHost::ownedPropLists

protectedinherited

Definition at line 102 of file C4ScriptHost.h.

Referenced by C4ScriptHost::DeleteOwnedPropLists().

Prev

C4ScriptHost* C4ScriptHost::Prev {nullptr}

protectedinherited

Definition at line 78 of file C4ScriptHost.h.

Referenced by C4ScriptHost::Reg2List(), and C4ScriptHost::Unreg().

Resolving

bool C4ScriptHost::Resolving

protectedinherited

Definition at line 88 of file C4ScriptHost.h.

Referenced by C4ScriptHost::C4ScriptHost(), and C4ScriptHost::ResolveIncludes().

Script

StdStrBuf C4ScriptHost::Script

protectedinherited

Definition at line 91 of file C4ScriptHost.h.

Referenced by C4ScriptHost::C4ScriptHost(), C4ScriptHost::Clear(), C4ScriptHost::GetScript(), C4ScriptHost::LoadData(), C4ScriptHost::MakeScript(), C4ScriptHost::Parse(), C4AulParse::Parse_Script(), and C4ScriptHost::Preparse().

ScriptName

StdCopyStrBuf C4ScriptHost::ScriptName

inherited

Definition at line 58 of file C4ScriptHost.h.

Referenced by C4AulParseError::C4AulParseError(), C4ScriptHost::Load(), C4ScriptHost::LoadData(), C4AulScriptContext::ReturnDump(), and C4ScriptHost::Warn().

SourceScripts

std::deque<C4ScriptHost *> C4ScriptHost::SourceScripts

inherited

Definition at line 57 of file C4ScriptHost.h.

Referenced by C4ScriptHost::C4ScriptHost(), C4ScriptHost::Clear(), C4ScriptHost::DoAppend(), C4ScriptHost::Parse(), and C4ScriptHost::ResolveIncludes().

State

C4AulScriptState C4ScriptHost::State {ASS_NONE}

protectedinherited

Definition at line 94 of file C4ScriptHost.h.

Referenced by C4ScriptHost::Clear(), C4ScriptHost::IsReady(), C4ScriptHost::Parse(), C4ScriptHost::Preparse(), C4ScriptHost::ResolveAppends(), C4ScriptHost::ResolveIncludes(), and C4ScriptHost::UnLink().

stringTable

C4LangStringTable* C4ScriptHost::stringTable

protectedinherited

Definition at line 92 of file C4ScriptHost.h.

Referenced by C4ScriptHost::C4ScriptHost(), C4ScriptHost::Clear(), C4ScriptHost::Load(), C4ScriptHost::LoadData(), C4ScriptHost::MakeScript(), C4ScriptHost::ReloadScript(), and C4ScriptHost::Translate().

---

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

• C4ScriptHost.h
• C4ScriptHost.cpp