C4PropertyPath Class Reference

#include <C4PropertyPath.h>

Public Types
enum	PathType {   PPT_Root = 0 , PPT_Property = 1 , PPT_Index = 2 , PPT_SetFunction = 3 ,   PPT_GlobalSetFunction = 4 , PPT_RootSetFunction = 5 }

Public Member Functions
	C4PropertyPath ()
	C4PropertyPath (C4PropList *target)
	C4PropertyPath (C4Effect *fx, C4Object *target_obj)
	C4PropertyPath (const char *path)
	C4PropertyPath (const C4PropertyPath &parent, int32_t elem_index)
	C4PropertyPath (const C4PropertyPath &parent, const char *child_property)
void	SetSetPath (const C4PropertyPath &parent, const char *child_property, PathType path_type)
void	Clear ()
const char *	GetGetPath () const
const char *	GetSetPath () const
const char *	GetRoot () const
bool	IsEmpty () const
C4Value	ResolveValue () const
C4Value	ResolveRoot () const
void	SetProperty (const char *set_string) const
void	SetProperty (const C4Value &to_val, const C4PropListStatic *ignore_reference_parent=nullptr) const
void	DoCall (const char *call_string) const
bool	operator== (const C4PropertyPath &v) const

Public Attributes
enum C4PropertyPath::PathType	get_path_type
enum C4PropertyPath::PathType	set_path_type

Detailed Description

Definition at line 27 of file C4PropertyPath.h.

Member Enumeration Documentation

PathType

enum C4PropertyPath::PathType

Enumerator
PPT_Root
PPT_Property
PPT_Index
PPT_SetFunction
PPT_GlobalSetFunction
PPT_RootSetFunction

Definition at line 34 of file C4PropertyPath.h.

    {
        PPT_Root = 0,
        PPT_Property = 1,
        PPT_Index = 2,
        PPT_SetFunction = 3,
        PPT_GlobalSetFunction = 4,
        PPT_RootSetFunction = 5,
    } get_path_type, set_path_type;

Constructor & Destructor Documentation

C4PropertyPath() [1/6]

C4PropertyPath::C4PropertyPath ( )

inline

Definition at line 45 of file C4PropertyPath.h.

{}

C4PropertyPath() [2/6]

C4PropertyPath::C4PropertyPath

(

C4PropList *

target

)

Definition at line 31 of file C4PropertyPath.cpp.

                                                 : get_path_type(PPT_Root), set_path_type(PPT_Root)
{
    // Build string to set target
    if (target)
    {
        // Object target
        C4Object *obj = target->GetObject();
        C4PropListStatic *target_static;
        if (obj)
        {
            get_path.Format("Object(%d)", (int)obj->Number);
            root = get_path;
        }
        else if ((target_static = target->IsStatic()))
        {
            // Global static prop lists: Resolve name
            get_path = target_static->GetDataString();
            root = get_path;
        }
        else
        {
            // Otherwise leave empty. We do not want assignments into temporary values, etc.
        }
    }
}

References StdStrBuf::Format(), C4PropListStatic::GetDataString(), C4PropList::GetObject(), C4PropList::IsStatic(), and C4PropListNumbered::Number.

Here is the call graph for this function:

C4PropertyPath() [3/6]

C4PropertyPath::C4PropertyPath	(	C4Effect *	fx,
		C4Object *	target_obj
	)

Definition at line 57 of file C4PropertyPath.cpp.

                                                                 : get_path_type(PPT_Root), set_path_type(PPT_Root)
{
    // Effect property path: Represent as GetEffect("name", Object(%d), index) for object effects and GetEffect("name", nil, index) for global effects
    if (!fx) return;
    const char *name = fx->GetName();
    int32_t index = 0;
    for (C4Effect *ofx = target_obj ? target_obj->pEffects : ::ScriptEngine.pGlobalEffects; ofx; ofx = ofx->pNext)
        if (ofx == fx) break; else if (!strcmp(ofx->GetName(), name)) ++index;
    if (target_obj)
    {
        get_path.Format(R"(GetEffect("%s", Object(%d), %d))", name, (int)target_obj->Number, (int)index);
        root.Format("Object(%d)", (int)target_obj->Number);
    }
    else
    {
        get_path.Format(R"(GetEffect("%s", nil, %d))", name, (int)index);
        root = ::Strings.P[P_Global].GetData();
    }
}

References StdStrBuf::Format(), C4String::GetData(), C4PropList::GetName(), C4PropListNumbered::Number, C4StringTable::P, P_Global, C4Object::pEffects, C4AulScriptEngine::pGlobalEffects, C4Effect::pNext, ScriptEngine, and Strings.

Here is the call graph for this function:

C4PropertyPath() [4/6]

C4PropertyPath::C4PropertyPath ( const char *  path )

inline

Definition at line 48 of file C4PropertyPath.h.

: get_path(path), root(path), get_path_type(PPT_Root), set_path_type(PPT_Root) {}

C4PropertyPath() [5/6]

C4PropertyPath::C4PropertyPath	(	const C4PropertyPath &	parent,
		int32_t	elem_index
	)

Definition at line 77 of file C4PropertyPath.cpp.

                                                                               : root(parent.root)
{
    get_path.Format("%s[%d]", parent.GetGetPath(), (int)elem_index);
    get_path_type = set_path_type = PPT_Index;
}

References StdStrBuf::Format(), get_path_type, GetGetPath(), PPT_Index, and set_path_type.

Here is the call graph for this function:

C4PropertyPath() [6/6]

C4PropertyPath::C4PropertyPath	(	const C4PropertyPath &	parent,
		const char *	child_property
	)

Definition at line 83 of file C4PropertyPath.cpp.

    : get_path_type(PPT_Property), set_path_type(PPT_Property), root(parent.root)
{
    get_path.Format("%s.%s", parent.GetGetPath(), child_property);
}

References StdStrBuf::Format(), and GetGetPath().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4PropertyPath::Clear ( )

inline

Definition at line 52 of file C4PropertyPath.h.

{ get_path.Clear(); set_path.Clear(); }

References StdStrBuf::Clear().

Here is the call graph for this function:

DoCall()

void C4PropertyPath::DoCall

(

const char *

call_string

)

const

Definition at line 143 of file C4PropertyPath.cpp.

{
    // Compose script call
    StdStrBuf script;
    script.Format(call_string, get_path.getData());
    // Execute synced scripted
    ::Console.EditCursor.EMControl(CID_Script, new C4ControlScript(script.getData(), 0, false));
}

References CID_Script, Console, C4Console::EditCursor, C4EditCursor::EMControl(), StdStrBuf::Format(), and StdStrBuf::getData().

Here is the call graph for this function:

GetGetPath()

const char* C4PropertyPath::GetGetPath ( ) const

inline

Definition at line 53 of file C4PropertyPath.h.

{ return get_path.getData(); }

References StdStrBuf::getData().

Referenced by C4PropertyPath(), and SetSetPath().

Here is the call graph for this function:

Here is the caller graph for this function:

GetRoot()

const char* C4PropertyPath::GetRoot ( ) const

inline

Definition at line 55 of file C4PropertyPath.h.

{ return root.getData(); } // Parent-most path (usually the object)

References StdStrBuf::getData().

Referenced by SetSetPath().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSetPath()

const char* C4PropertyPath::GetSetPath ( ) const

inline

Definition at line 54 of file C4PropertyPath.h.

{ return set_path ? set_path.getData() : get_path.getData(); }

References StdStrBuf::getData().

Referenced by SetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

IsEmpty()

bool C4PropertyPath::IsEmpty ( ) const

inline

Definition at line 56 of file C4PropertyPath.h.

{ return get_path.getLength() <= 0; }

References StdStrBuf::getLength().

Here is the call graph for this function:

operator==()

bool C4PropertyPath::operator== ( const C4PropertyPath &  v ) const

inline

Definition at line 64 of file C4PropertyPath.h.

{ return get_path == v.get_path; }

ResolveRoot()

C4Value C4PropertyPath::ResolveRoot

(

)

const

Definition at line 137 of file C4PropertyPath.cpp.

{
    if (!root.getLength()) return C4VNull;
    return AulExec.DirectExec(::ScriptEngine.GetPropList(), root.getData(), "resolve property root", false, nullptr);
}

References AulExec, C4VNull, C4AulExec::DirectExec(), StdStrBuf::getData(), StdStrBuf::getLength(), C4AulScriptEngine::GetPropList(), and ScriptEngine.

Here is the call graph for this function:

ResolveValue()

C4Value C4PropertyPath::ResolveValue

(

)

const

Definition at line 131 of file C4PropertyPath.cpp.

{
    if (!get_path.getLength()) return C4VNull;
    return AulExec.DirectExec(::ScriptEngine.GetPropList(), get_path.getData(), "resolve property", false, nullptr);
}

References AulExec, C4VNull, C4AulExec::DirectExec(), StdStrBuf::getData(), StdStrBuf::getLength(), C4AulScriptEngine::GetPropList(), and ScriptEngine.

Here is the call graph for this function:

SetProperty() [1/2]

void C4PropertyPath::SetProperty	(	const C4Value &	to_val,
		const C4PropListStatic *	ignore_reference_parent = nullptr
	)		const

Definition at line 126 of file C4PropertyPath.cpp.

{
    SetProperty(to_val.GetDataString(9999999, ignore_reference_parent).getData());
}

References StdStrBuf::getData(), C4Value::GetDataString(), and SetProperty().

Here is the call graph for this function:

SetProperty() [2/2]

void C4PropertyPath::SetProperty

(

const char *

set_string

)

const

Definition at line 111 of file C4PropertyPath.cpp.

{
    // Compose script to update property
    const char *set_path_c = GetSetPath();
    StdStrBuf script;
    if (set_path_type == PPT_SetFunction || set_path_type == PPT_RootSetFunction)
        script.Format("%s(%s)", set_path_c, set_string);
    else if (set_path_type == PPT_GlobalSetFunction)
        script.Format("%s(%s,%s)", argument.getData(), set_path_c, set_string);
    else
        script.Format("%s=%s", set_path_c, set_string);
    // Execute synced scripted
    ::Console.EditCursor.EMControl(CID_Script, new C4ControlScript(script.getData(), 0, false));
}

References CID_Script, Console, C4Console::EditCursor, C4EditCursor::EMControl(), StdStrBuf::Format(), StdStrBuf::getData(), GetSetPath(), PPT_GlobalSetFunction, PPT_RootSetFunction, PPT_SetFunction, and set_path_type.

Referenced by SetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

SetSetPath()

void C4PropertyPath::SetSetPath	(	const C4PropertyPath &	parent,
		const char *	child_property,
		C4PropertyPath::PathType	path_type
	)

Definition at line 89 of file C4PropertyPath.cpp.

{
    set_path_type = path_type;
    if (path_type == PPT_Property)
        set_path.Format("%s.%s", parent.GetGetPath(), child_property);
    else if (path_type == PPT_SetFunction)
        set_path.Format("%s->%s", parent.GetGetPath(), child_property);
    else if (path_type == PPT_GlobalSetFunction)
    {
        set_path.Copy(parent.GetGetPath());
        argument.Copy(child_property);
    }
    else if (path_type == PPT_RootSetFunction)
    {
        set_path.Format("%s->%s", parent.GetRoot(), child_property);
    }
    else
    {
        assert(false);
    }
}

References StdStrBuf::Copy(), StdStrBuf::Format(), GetGetPath(), GetRoot(), PPT_GlobalSetFunction, PPT_Property, PPT_RootSetFunction, PPT_SetFunction, and set_path_type.

Here is the call graph for this function:

Member Data Documentation

get_path_type

enum C4PropertyPath::PathType C4PropertyPath::get_path_type

Referenced by C4PropertyPath().

set_path_type

enum C4PropertyPath::PathType C4PropertyPath::set_path_type

Referenced by C4PropertyPath(), SetProperty(), and SetSetPath().

---

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

• C4PropertyPath.h
• C4PropertyPath.cpp