A Routine is an abstract representation of a method. More...

Public Member Functions
	Routine (Type result, string name, List< Type > parameters)
	Routine (Type result, string name, List< Type > parameterTypes, string description)
	Routine (string name)
	Routine (string name, string description)
	Routine (Type result, string name)
	Routine (Type result, string name, string description)
	Routine (Type result, string name, Type parameter)
	Routine (Type result, string name, Type parameter, string description)
	Routine (Type result, string name, Type parameter0, Type parameter1)
	Routine (Type result, string name, Type parameter0, Type parameter1, string description)
	Routine (Type result, string name, Type parameter0, Type parameter1, Type parameter2)
	Routine (Type result, string name, Type parameter0, Type parameter1, Type parameter2, string description)
void	Verify (List< object > parameters)
	Verify the parameter types of a Routine. If null or void was specified values arent verified.
void	Verify (object result)
	Verify the result of a Routine. If null or void was specified values arent verified.
override string	ToString ()
string	Description ()

Properties
string	Name `[get]`
List< Type >	ParameterTypes `[get]`
Type	Result `[get]`
Host	Handler `[get, set]`

Private Member Functions
void	Validate (Type type)
string	ToString (Type type)

Private Attributes
string	name
List< Type >	parameters
Type	result
string	description
Host	host

Detailed Description

A Routine is an abstract representation of a method.

To successfully write a routine you have to use one of its several overloaded cunstuctors listed above and pass up to a maximum of 3 parameters.

Routine myRoutine;
 
myRoutine = new Routine( 
    typeof(int), // return value (optional)
    "myFunction", // name of the function (required)
    typeof(int), typeof(float), typeof(bool), // up to 3 parameters (optional)
    "Describe your custom method" // a description (optional)
);

To declare more then 3 parameters you can add them to a list and add the list as parameter

// create a generic list ..
List<Type> customParameter = new List<Type>();
 
// .. add all parameter types
customParameter.Add(typeof(int));
customParameter.Add(typeof(float));
customParameter.Add(typeof(bool));
customParameter.Add(typeof(int));
 
// .. and add them as a parameter
Routine myRoutine = new Routine( 
    typeof(int), 
    "myFunction", 
    typeof(customParameter), // the list as parameter
    "Describe your function" 
);

The Manager can invoke a Routine by using the Invoke method.

Routine myRoutine = manager.Routines["print"];
 
List<object> parameters = new List<object>();
parameters.Add("Hello world");
 
myRoutine.Handler.Invoke(myRoutine.Name, parameters);

See also: Manager, Host

Todo: The Constructor has serveral (way too much) Overloaders

Definition at line 69 of file Routine.cs.

Constructor & Destructor Documentation

◆ Routine() [1/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		List< Type >	parameters )

Definition at line 137 of file Routine.cs.

                                                                        {
 
            Validate(result);
 
            foreach (Type parameter in parameters)
                Validate(parameter);
 
            this.result = result;
            this.name = name;
            this.parameters = parameters;
 
            host = null;
 
        }

References host, name, parameters, result, and Validate().

◆ Routine() [2/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		List< Type >	parameterTypes,
		string	description )

Definition at line 152 of file Routine.cs.

        {
 
            Validate(result);
 
            foreach (Type parameter in parameterTypes)
                Validate(parameter);
 
            this.result = result;
            this.name = name;
            this.parameters = parameterTypes;
            this.description = description;
            host = null;
 
        }

References description, host, name, result, and Validate().

◆ Routine() [3/12]

ScriptStack.Runtime.Routine.Routine ( string name )

Definition at line 168 of file Routine.cs.

                                    : this(null, name, new List<Type>())
        {
        }

References name.

◆ Routine() [4/12]

ScriptStack.Runtime.Routine.Routine	(	string	name,
		string	description )

Definition at line 172 of file Routine.cs.

                                                        : this(null, name, new List<Type>(), description)
        {
        }

References description, and name.

◆ Routine() [5/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name )

Definition at line 176 of file Routine.cs.

                                                 : this(result, name, new List<Type>())
        {
        }

References name, and result.

◆ Routine() [6/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		string	description )

Definition at line 180 of file Routine.cs.

                                                                     : this(result, name, new List<Type>(), description)
        {
        }

References description, name, and result.

◆ Routine() [7/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter )

Definition at line 184 of file Routine.cs.

                                                                 : this(result, name, new List<Type>())
        {
            parameters.Add(parameter);
        }

References name, parameters, and result.

◆ Routine() [8/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter,
		string	description )

Definition at line 189 of file Routine.cs.

                                                                                     : this(result, name, new List<Type>(), description)
        {
            parameters.Add(parameter);
        }

References description, name, parameters, and result.

◆ Routine() [9/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter0,
		Type	parameter1 )

Definition at line 194 of file Routine.cs.

                                                                                   : this(result, name, new List<Type>())
        {
            parameters.Add(parameter0);
            parameters.Add(parameter1);
        }

References name, parameters, and result.

◆ Routine() [10/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter0,
		Type	parameter1,
		string	description )

Definition at line 200 of file Routine.cs.

                                                                                                       : this(result, name, new List<Type>(), description)
        {
            parameters.Add(parameter0);
            parameters.Add(parameter1);
        }

References description, name, parameters, and result.

◆ Routine() [11/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter0,
		Type	parameter1,
		Type	parameter2 )

Definition at line 206 of file Routine.cs.

                                                                                                    : this(result, name, new List<Type>())
        {
            parameters.Add(parameter0);
            parameters.Add(parameter1);
            parameters.Add(parameter2);
        }

References name, parameters, and result.

◆ Routine() [12/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter0,
		Type	parameter1,
		Type	parameter2,
		string	description )

Definition at line 213 of file Routine.cs.

                                                                                                                        : this(result, name, new List<Type>(), description)
        {
            parameters.Add(parameter0);
            parameters.Add(parameter1);
            parameters.Add(parameter2);
        }

References description, name, parameters, and result.

Member Function Documentation

◆ Description()

string ScriptStack.Runtime.Routine.Description ( )

Definition at line 298 of file Routine.cs.

        {
            return description;
        }

References description.

Referenced by ScriptStack.Compiler.Parser.RoutineCall().

◆ ToString() [1/2]

override string ScriptStack.Runtime.Routine.ToString ( )

Definition at line 268 of file Routine.cs.

        {
 
            StringBuilder sb = new StringBuilder();
 
            //if(result != (Type)null)
                sb.Append(ToString(result) + " ");
 
            sb.Append(name);
 
            sb.Append("(");
 
            int i = 0;
 
            for (i = 0; i < parameters.Count; i++)
            {
 
                if (i > 0)
                    sb.Append(", ");
 
                sb.Append(ToString(parameters[i]));
 
            }
 
            sb.Append(")");
 
            return sb.ToString();
 
        }

References name, parameters, result, and ToString().

Referenced by ToString().

◆ ToString() [2/2]

string ScriptStack.Runtime.Routine.ToString ( Type type )

private

Definition at line 103 of file Routine.cs.

        {
 
            string tmp = "";
 
            if (type == null)
                tmp = "null";
            else if (type == typeof(void))
                tmp = "void";
            else if (type == typeof(int))
                tmp = "int";
            else if (type == typeof(float))
                tmp = "float";
            else if (type == typeof(double))
                tmp = "double";
            else if (type == typeof(bool))
                tmp = "bool";
            else if (type == typeof(char))
                tmp = "char";
            else if (type == typeof(string))
                tmp = "string";
            else if (type == typeof(ArrayList))
                tmp = "array";
            else
                tmp = type.ToString().Replace("System.", "").ToLower();
 
            return tmp;
 
        }

◆ Validate()

void ScriptStack.Runtime.Routine.Validate ( Type type )

private

Definition at line 84 of file Routine.cs.

        {
 
            if (type == null || type == typeof(void))
                return;
 
            if (type != typeof(int)
                && type != typeof(float)
                && type != typeof(bool)
                && type != typeof(double)
                && type != typeof(decimal)
                && type != typeof(string)
                && type != typeof(char)
                && type != typeof(ArrayList)
                )
                throw new ExecutionException("Der Typ '" + type.Name + "' ist kein generischer Datentyp und es wurden keine Erweiterungen registriert.");
 
        }

Referenced by Routine(), and Routine().

◆ Verify() [1/2]

void ScriptStack.Runtime.Routine.Verify ( List< object > parameters )

Verify the parameter types of a Routine. If null or void was specified values arent verified.

Parameters

parameters

Definition at line 224 of file Routine.cs.

        {
 
            if (parameters.Count != this.parameters.Count)
                throw new ExecutionException("Die Routine '" + name + "' wurde mit " + parameters.Count  + " statt erwarteten " + this.parameters.Count  + " Parametern aufgerufen.");
 
            for (int i = 0; i < parameters.Count; i++)
            {
 
                if (null == this.parameters[i] || null == parameters[i])
                    continue;
 
                if (typeof(void) == this.parameters[i] || typeof(void) == parameters[i])
                    continue;
 
                Type expected = this.parameters[i];
 
                Type specified = parameters[i].GetType();
 
                if (expected != specified)
                    throw new ExecutionException("Typ '" + specified.Name + "' statt erwartetem Typ '" + expected.Name + "' als " + (i + 1) + " Parameter von '" + name +"' angegeben.");
 
            }
 
        }

References name, and parameters.

Referenced by ScriptStack.Runtime.Interpreter.INV().

◆ Verify() [2/2]

void ScriptStack.Runtime.Routine.Verify ( object result )

Verify the result of a Routine. If null or void was specified values arent verified.

Parameters

result

Definition at line 254 of file Routine.cs.

        {
 
            if (null == this.result || null == result)
                return;
 
            if (typeof(void) == this.result || typeof(void) == result)
                return;
 
            if (result.GetType() != this.result)
                throw new ExecutionException("Typ '" + result.GetType().Name + "' statt erwartetem Typ '"  + this.result.Name + "' als Ergebnis von '" + name + "' erhalten.");
 
        }

References name, and result.

Member Data Documentation

◆ description

string ScriptStack.Runtime.Routine.description

private

Definition at line 77 of file Routine.cs.

Referenced by Description(), Routine(), Routine(), Routine(), Routine(), Routine(), and Routine().

◆ host

Host ScriptStack.Runtime.Routine.host

private

Definition at line 78 of file Routine.cs.

Referenced by Routine(), and Routine().

◆ name

string ScriptStack.Runtime.Routine.name

private

Definition at line 74 of file Routine.cs.

Referenced by Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), ToString(), Verify(), and Verify().

◆ parameters

List<Type> ScriptStack.Runtime.Routine.parameters

private

Definition at line 75 of file Routine.cs.

Referenced by Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), ToString(), and Verify().

◆ result

Type ScriptStack.Runtime.Routine.result

private

Definition at line 76 of file Routine.cs.

Referenced by Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), Routine(), ToString(), and Verify().

Property Documentation

◆ Handler

Host ScriptStack.Runtime.Routine.Handler

getset

Definition at line 322 of file Routine.cs.

        {
            get { return host; }
            internal set { host = value; }
        }

Referenced by ScriptStack.Runtime.Interpreter.INV().

◆ Name

string ScriptStack.Runtime.Routine.Name

get

Definition at line 307 of file Routine.cs.

        {
            get { return name; }
        }

Referenced by ScriptStack.Runtime.Interpreter.INV(), ScriptStack.Manager.Register(), and ScriptStack.Manager.UnRegister().

◆ ParameterTypes

List<Type> ScriptStack.Runtime.Routine.ParameterTypes

get

Definition at line 312 of file Routine.cs.

        {
            get { return parameters; }
        }

Referenced by ScriptStack.Runtime.Interpreter.INV(), and ScriptStack.Compiler.Parser.RoutineCall().

◆ Result

Type ScriptStack.Runtime.Routine.Result

get

Definition at line 317 of file Routine.cs.

        {
            get { return result; }
        }

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

Src/Runtime/Routine.cs

Public Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Routine() [1/12]

◆ Routine() [2/12]

◆ Routine() [3/12]

◆ Routine() [4/12]

◆ Routine() [5/12]

◆ Routine() [6/12]

◆ Routine() [7/12]

◆ Routine() [8/12]

◆ Routine() [9/12]

◆ Routine() [10/12]

◆ Routine() [11/12]

◆ Routine() [12/12]

Member Function Documentation

◆ Description()

◆ ToString() [1/2]

◆ ToString() [2/2]

◆ Validate()

◆ Verify() [1/2]

◆ Verify() [2/2]

Member Data Documentation

◆ description

◆ host

◆ name

◆ parameters

◆ result

Property Documentation

◆ Handler

◆ Name

◆ ParameterTypes

◆ Result