C4AulExec Class Reference

#include <C4AulExec.h>

Public Member Functions
	C4AulExec ()
C4Value	Exec (C4AulScriptFunc *pSFunc, C4PropList *p, C4Value pPars[], bool fPassErrors)
C4Value	DirectExec (C4PropList *p, const char *szScript, const char *szContext, bool fPassErrors=false, C4AulScriptContext *context=nullptr, bool parse_function=false)
void	StartTrace ()
void	StartDirectExec ()
void	StopDirectExec ()
int	GetContextDepth () const
C4AulScriptContext *	GetContext (int iLevel)
void	LogCallStack ()
void	ClearPointers (C4Object *)

Static Public Member Functions
static C4String *	FnTranslate (C4PropList *_this, C4String *text)
static bool	FnLogCallStack (C4PropList *_this)

Friends
class	C4AulProfiler

Detailed Description

Definition at line 54 of file C4AulExec.h.

Constructor & Destructor Documentation

C4AulExec()

C4AulExec::C4AulExec ( )

inline

Definition at line 58 of file C4AulExec.h.

            : pCurCtx(Contexts - 1), pCurVal(Values - 1)
    { }

Member Function Documentation

ClearPointers()

void C4AulExec::ClearPointers

(

C4Object *

obj

)

Definition at line 136 of file C4AulExec.cpp.

{
    for (C4AulScriptContext *pCtx = pCurCtx; pCtx >= Contexts; pCtx--)
    {
        if (pCtx->Obj == obj)
            pCtx->Obj = nullptr;
    }
}

Referenced by C4Game::ClearPointers().

Here is the caller graph for this function:

DirectExec()

C4Value C4AulExec::DirectExec	(	C4PropList *	p,
		const char *	szScript,
		const char *	szContext,
		bool	fPassErrors = false,
		C4AulScriptContext *	context = nullptr,
		bool	parse_function = false
	)

Definition at line 1012 of file C4AulExec.cpp.

{
    if (DEBUGREC_SCRIPT && Config.General.DebugRec)
    {
        AddDbgRec(RCT_DirectExec, szScript, strlen(szScript)+1);
        int32_t iObjNumber = p && p->GetPropListNumbered() ? p->GetPropListNumbered()->Number : -1;
        AddDbgRec(RCT_DirectExec, &iObjNumber, sizeof(int32_t));
    }
    // profiler
    StartDirectExec();
    C4PropListStatic * script = ::GameScript.GetPropList();
    if (p && p->IsStatic())
        script = p->IsStatic();
    else if (p && p->GetDef())
        script = p->GetDef();
    // Add a new function
    auto pFunc = std::make_unique<C4AulScriptFunc>(script, nullptr, nullptr, szScript);
    // Parse function
    try
    {
        if (parse_function)
        {
            // Expect a full function (e.g. "func foo() { return bar(); }")
            pFunc->ParseDirectExecFunc(&::ScriptEngine, context);
        }
        else
        {
            // Expect a single statement (e.g. "bar()")
            pFunc->ParseDirectExecStatement(&::ScriptEngine, context);
        }
        C4AulParSet Pars;
        C4Value vRetVal(Exec(pFunc.get(), p, Pars.Par, fPassErrors));
        // profiler
        StopDirectExec();
        return vRetVal;
    }
    catch (C4AulError &ex)
    {
        if(fPassErrors)
            throw;
        ::ScriptEngine.GetErrorHandler()->OnError(ex.what());
        LogCallStack();
        StopDirectExec();
        return C4VNull;
    }
}

References AddDbgRec(), C4VNull, Config, C4ConfigGeneral::DebugRec, DEBUGREC_SCRIPT, Exec(), GameScript, C4Config::General, C4PropList::GetDef(), C4AulScriptEngine::GetErrorHandler(), C4GameScriptHost::GetPropList(), C4PropList::GetPropListNumbered(), C4PropList::IsStatic(), LogCallStack(), C4PropListNumbered::Number, C4AulErrorHandler::OnError(), C4AulParSet::Par, C4AulScriptFunc::ParseDirectExecFunc(), C4AulScriptFunc::ParseDirectExecStatement(), RCT_DirectExec, ScriptEngine, StartDirectExec(), StopDirectExec(), and C4AulError::what().

Referenced by C4Object::MenuCommand(), C4ObjectMenu::MenuCommand(), C4EditCursor::PerformDuplication(), C4PropertyPath::ResolveRoot(), and C4PropertyPath::ResolveValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Exec()

C4Value C4AulExec::Exec	(	C4AulScriptFunc *	pSFunc,
		C4PropList *	p,
		C4Value	pPars[],
		bool	fPassErrors
	)

Referenced by DirectExec(), and C4AulScriptFunc::Exec().

Here is the caller graph for this function:

FnLogCallStack()

bool C4AulExec::FnLogCallStack ( C4PropList *  _this )

static

Definition at line 130 of file C4AulExec.cpp.

{
    AulExec.LogCallStack();
    return true;
}

References AulExec, and LogCallStack().

Referenced by InitCoreFunctionMap().

Here is the call graph for this function:

Here is the caller graph for this function:

FnTranslate()

C4String * C4AulExec::FnTranslate ( C4PropList *  _this, C4String *  text  )

static

Definition at line 100 of file C4AulExec.cpp.

{
#define ReturnIfTranslationAvailable(script, key) do \
{ \
    const auto &s = script; \
    const auto &k = key; \
    if (s) \
    { \
        try \
        { \
            return ::Strings.RegString(s->Translate(k).c_str()); \
        } \
        catch (C4LangStringTable::NoSuchTranslation &) {} \
    } \
} while(0)
 
    if (!text || text->GetData().isNull()) return nullptr;
    // Find correct script: translations of the context if possible, containing script as fallback
    if (_this && _this->GetDef())
        ReturnIfTranslationAvailable(&(_this->GetDef()->Script), text->GetCStr());
    ReturnIfTranslationAvailable(AulExec.pCurCtx[0].Func->pOrgScript, text->GetCStr());
 
    // No translation available, log
    DebugLogF(R"(WARNING: Translate: no translation for string "%s")", text->GetCStr());
    // Trace
    AulExec.LogCallStack();
    return text;
#undef ReturnIfTranslationAvailable
}

References AulExec, DebugLogF(), C4AulScriptContext::Func, C4PropList::GetDef(), LogCallStack(), C4AulScriptFunc::pOrgScript, ReturnIfTranslationAvailable, C4Def::Script, and C4ScriptGuiWindowPropertyName::text.

Referenced by InitCoreFunctionMap().

Here is the call graph for this function:

Here is the caller graph for this function:

GetContext()

C4AulScriptContext* C4AulExec::GetContext ( int  iLevel )

inline

Definition at line 88 of file C4AulExec.h.

{ return iLevel >= 0 && iLevel < GetContextDepth() ? Contexts + iLevel : nullptr; }

References GetContextDepth().

Referenced by C4AulDebug::DebugStep().

Here is the call graph for this function:

Here is the caller graph for this function:

GetContextDepth()

int C4AulExec::GetContextDepth ( ) const

inline

Definition at line 87 of file C4AulExec.h.

{ return pCurCtx - Contexts + 1; }

Referenced by C4AulDebug::DebugStep(), and GetContext().

Here is the caller graph for this function:

LogCallStack()

void C4AulExec::LogCallStack

(

)

Definition at line 94 of file C4AulExec.cpp.

{
    for (C4AulScriptContext *pCtx = pCurCtx; pCtx >= Contexts; pCtx--)
        pCtx->dump(StdStrBuf(" by: "));
}

Referenced by DirectExec(), FnLogCallStack(), and FnTranslate().

Here is the caller graph for this function:

StartDirectExec()

void C4AulExec::StartDirectExec ( )

inline

Definition at line 84 of file C4AulExec.h.

{ if (fProfiling) tDirectExecStart = C4TimeMilliseconds::Now(); }

References C4TimeMilliseconds::Now().

Referenced by DirectExec().

Here is the call graph for this function:

Here is the caller graph for this function:

StartTrace()

void C4AulExec::StartTrace

(

)

Definition at line 905 of file C4AulExec.cpp.

{
    if (iTraceStart < 0)
        iTraceStart = ContextStackSize();
}

StopDirectExec()

void C4AulExec::StopDirectExec ( )

inline

Definition at line 85 of file C4AulExec.h.

{ if (fProfiling) tDirectExecTotal += C4TimeMilliseconds::Now() - tDirectExecStart; }

References C4TimeMilliseconds::Now().

Referenced by DirectExec().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

C4AulProfiler

friend class C4AulProfiler

friend

Definition at line 78 of file C4AulExec.h.

---

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

• C4AulExec.h
• C4AulExec.cpp