#include <C4AulFunc.h>

Inheritance diagram for C4AulFunc:

Collaboration diagram for C4AulFunc:

Public Member Functions
	C4AulFunc (C4PropListStatic Parent, const char pName)

const char *	GetName () const

virtual StdStrBuf	GetFullName () const

virtual C4AulScriptFunc *	SFunc ()

virtual bool	GetPublic () const

virtual int	GetParCount () const

virtual const C4V_Type *	GetParType () const =0

virtual C4V_Type	GetRetType () const =0

C4Value	Exec (C4PropList p=nullptr, C4AulParSet pPars=nullptr, bool fPassErrors=false)

virtual C4Value	Exec (C4PropList *p, C4Value pPars[], bool fPassErrors=false)=0

bool	CheckParTypes (const C4Value pPars[], bool fPassErrors) const

void	IncRef ()

void	DecRef ()

Public Attributes
C4PropListStatic *	Parent

Protected Member Functions
	~C4AulFunc () override

Protected Attributes
C4RefCntPointer< C4String >	Name

C4AulFunc *	MapNext

unsigned int	RefCnt {0}

Friends
class	C4AulScriptEngine

class	C4AulFuncMap

class	C4AulParse

class	C4ScriptHost

Detailed Description

Definition at line 46 of file C4AulFunc.h.

Constructor & Destructor Documentation

◆ C4AulFunc()

C4AulFunc::C4AulFunc	(	C4PropListStatic *	Parent,
		const char *	pName
	)

Definition at line 22 of file C4AulFunc.cpp.

                                                                 :
         Parent(Parent),
         Name(pName ? Strings.RegString(pName) : nullptr),
         MapNext(nullptr)
 {
     // add to global lookuptable with this name
     if (GetName())
         ::ScriptEngine.FuncLookUp.Add(this);
 }

References C4AulFuncMap::Add(), C4AulScriptEngine::FuncLookUp, GetName(), and ScriptEngine.

Here is the call graph for this function:

◆ ~C4AulFunc()

C4AulFunc::~C4AulFunc ( )

overrideprotected

Definition at line 32 of file C4AulFunc.cpp.

 {
     if (GetName())
         ::ScriptEngine.FuncLookUp.Remove(this);
 }

References C4AulScriptEngine::FuncLookUp, GetName(), C4AulFuncMap::Remove(), and ScriptEngine.

Here is the call graph for this function:

Member Function Documentation

◆ CheckParTypes()

bool C4AulFunc::CheckParTypes	(	const C4Value	pPars[],
		bool	fPassErrors
	)		const

Definition at line 58 of file C4AulFunc.cpp.

                                                                            {
     // Convert parameters (typecheck)
     const C4V_Type *pTypes = GetParType();
     int parcount = GetParCount();
     for (int i = 0; i < parcount; i++) {
         if (!pPars[i].CheckParConversion(pTypes[i]))
         {
             C4AulExecError e(FormatString(
                 R"(call to "%s" parameter %d: passed %s, but expected %s)",
                 GetName(), i + 1, pPars[i].GetTypeName(), GetC4VName(pTypes[i])).getData());
             if (fPassErrors)
                 throw e;
             else
             {
                 ::ScriptEngine.GetErrorHandler()->OnError(e.what());
                 return false;
             }
         }
     }
     return true;
 }

References FormatString(), GetC4VName(), C4AulScriptEngine::GetErrorHandler(), GetName(), GetParCount(), GetParType(), C4AulErrorHandler::OnError(), ScriptEngine, and C4AulError::what().

Referenced by Exec().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DecRef()

void C4RefCnt::DecRef ( )

inlineinherited

Definition at line 28 of file C4StringTable.h.

28 { if (!--RefCnt) delete this; }

C4RefCnt::RefCnt

unsigned int RefCnt

Definition: C4StringTable.h:31

References C4RefCnt::RefCnt.

Referenced by C4Command::Clear(), C4Command::CompileFunc(), C4Property::CompileFunc(), C4Def::GetActionByName(), C4Property::operator=(), C4Object::SetActionByName(), C4AulScriptFunc::SetOverloaded(), C4ScriptHost::UnlinkOwnedFunctions(), C4AulScriptFunc::~C4AulScriptFunc(), C4Property::~C4Property(), C4ScriptGuiWindow::~C4ScriptGuiWindow(), and C4ScriptGuiWindowAction::~C4ScriptGuiWindowAction().

Here is the caller graph for this function:

◆ Exec() [1/2]

virtual C4Value C4AulFunc::Exec	(	C4PropList *	p,
		C4Value	pPars[],
		bool	fPassErrors = `false`
	)

pure virtual

Implemented in C4AulScriptFunc, C4AulDefFunc, and C4AulEngineFunc< RType, ThisType, ParTypes >.

◆ Exec() [2/2]

C4Value C4AulFunc::Exec	(	C4PropList *	p = `nullptr`,
		C4AulParSet *	pPars = `nullptr`,
		bool	fPassErrors = `false`
	)

inline

Definition at line 72 of file C4AulFunc.h.

     {
         // Every parameter type allows conversion from nil, so no parameters are always allowed
         if (!pPars)
             return Exec(p, C4AulParSet().Par, fPassErrors);
         if (!CheckParTypes(pPars->Par, fPassErrors)) return C4Value();
         return Exec(p, pPars->Par, fPassErrors);
     }

References CheckParTypes().

Referenced by C4PropList::Call(), C4Effect::CallDamage(), C4Effect::CallEffect(), C4Effect::CallStart(), C4Effect::CallStop(), C4Effect::CallTimer(), C4Effect::DoCall(), C4MCCallbackArray::Execute(), C4MaterialMap::mrfScript(), C4Player::NotifyOwnedObjects(), and C4Object::PutAwayUnusedObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFullName()

StdStrBuf C4AulFunc::GetFullName ( ) const

virtual

Definition at line 38 of file C4AulFunc.cpp.

 {
     StdStrBuf r;
     // "lost" function?
     if (!Parent)
     {
         r.Ref("(unowned) ");
     }
     else
     {
         r.Take(Parent->GetDataString());
         r.AppendChar('.');
     }
     if (GetName())
         r.Append(Name->GetData());
     else
         r.Append("(unnamed)");
     return r;
 }