ScriptStack.Runtime.Function Class Reference

A function, forward declared in a script. More...

Public Member Functions
	Function (Executable executable, string name, List< string > parameters, Instruction entryPoint)
override string	ToString ()

Properties
Executable	Executable [get]
string	Name [get]
uint	ParameterCount [get]
ReadOnlyCollection< string >	Parameters [get]
Instruction	EntryPoint [get, set]

Private Attributes
Executable	executable
string	name
List< string >	parameters
Instruction	entryPoint

Detailed Description

A function, forward declared in a script.

Definition at line 14 of file Function.cs.

Constructor & Destructor Documentation

Function()

ScriptStack.Runtime.Function.Function	(	Executable	executable,
		string	name,
		List< string >	parameters,
		Instruction	entryPoint )

Definition at line 28 of file Function.cs.

        {
 
            this.executable = executable;
 
            this.name = name;
 
            this.parameters = new List<string>(parameters);
 
            this.entryPoint = entryPoint;
 
        }

References entryPoint, Executable, executable, name, and parameters.

Member Function Documentation

ToString()

override string ScriptStack.Runtime.Function.ToString

(

)

Definition at line 41 of file Function.cs.

        {
 
            StringBuilder sb = new StringBuilder();
 
            sb.Append(name + "@" + entryPoint.Address.ToString("X8"));
 
            sb.Append("(");
 
            for (int i = 0; i < parameters.Count; i++)
            {
 
                if (i > 0)
                    sb.Append(", ");
 
                sb.Append(parameters[i]);
 
            }
 
            sb.Append(") ");
 
            return sb.ToString();
 
        }

References entryPoint, name, and parameters.

Member Data Documentation

entryPoint

Instruction ScriptStack.Runtime.Function.entryPoint

private

Definition at line 22 of file Function.cs.

Referenced by Function(), and ToString().

executable

Executable ScriptStack.Runtime.Function.executable

private

Definition at line 19 of file Function.cs.

Referenced by Function().

name

string ScriptStack.Runtime.Function.name

private

Definition at line 20 of file Function.cs.

Referenced by Function(), and ToString().

parameters

List<string> ScriptStack.Runtime.Function.parameters

private

Definition at line 21 of file Function.cs.

Referenced by Function(), and ToString().

Property Documentation

EntryPoint

Instruction ScriptStack.Runtime.Function.EntryPoint

getset

Definition at line 86 of file Function.cs.

        {
            get { return entryPoint; }
            set { entryPoint = value; }
        }

Referenced by ScriptStack.Runtime.Operand.ToString().

Executable

Executable ScriptStack.Runtime.Function.Executable

get

Definition at line 66 of file Function.cs.

        {
            get { return executable; }
        }

Referenced by Function().

Name

string ScriptStack.Runtime.Function.Name

get

Definition at line 71 of file Function.cs.

        {
            get { return name; }
        }

ParameterCount

uint ScriptStack.Runtime.Function.ParameterCount

get

Definition at line 76 of file Function.cs.

        {
            get { return (uint) parameters.Count; }
        }

Parameters

ReadOnlyCollection<string> ScriptStack.Runtime.Function.Parameters

get

Definition at line 81 of file Function.cs.

        {
            get { return parameters.AsReadOnly(); }
        }

---

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

• Src/Runtime/Function.cs