ScriptStack.Runtime.Routine Klassenreferenz

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

Öffentliche Methoden
	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 ()

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

Private Methoden
void	Validate (Type type)
string	ToString (Type type)

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

Ausführliche Beschreibung

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);

Siehe auch

Manager, Host

Noch zu erledigen

The Constructor has serveral (way too much) Overloaders

Beschreibung der Konstruktoren und Destruktoren

Routine() [1/12]

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

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

Benutzt ScriptStack.Runtime.Routine.host, ScriptStack.Runtime.Routine.name, ScriptStack.Runtime.Routine.parameters, ScriptStack.Runtime.Routine.result und ScriptStack.Runtime.Routine.Validate().

Routine() [2/12]

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

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

Benutzt ScriptStack.Runtime.Routine.description, ScriptStack.Runtime.Routine.host, ScriptStack.Runtime.Routine.name, ScriptStack.Runtime.Routine.result und ScriptStack.Runtime.Routine.Validate().

Routine() [3/12]

ScriptStack.Runtime.Routine.Routine

(

string

name

)

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

Routine() [4/12]

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

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

Routine() [5/12]

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

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

Routine() [6/12]

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

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

Routine() [7/12]

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

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

Benutzt ScriptStack.Runtime.Routine.parameters.

Routine() [8/12]

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

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

Benutzt ScriptStack.Runtime.Routine.parameters.

Routine() [9/12]

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

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

Benutzt ScriptStack.Runtime.Routine.parameters.

Routine() [10/12]

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

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

Benutzt ScriptStack.Runtime.Routine.parameters.

Routine() [11/12]

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

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

Benutzt ScriptStack.Runtime.Routine.parameters.

Routine() [12/12]

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

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

Benutzt ScriptStack.Runtime.Routine.parameters.

Dokumentation der Elementfunktionen

Description()

string ScriptStack.Runtime.Routine.Description

(

)

        {
            return description;
        }

Benutzt ScriptStack.Runtime.Routine.description.

Wird benutzt von ScriptStack.Compiler.Parser.RoutineCall().

ToString() [1/2]

override string ScriptStack.Runtime.Routine.ToString

(

)

        {
 
            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();
 
        }

Benutzt ScriptStack.Runtime.Routine.name, ScriptStack.Runtime.Routine.parameters, ScriptStack.Runtime.Routine.result und ScriptStack.Runtime.Routine.ToString().

Wird benutzt von ScriptStack.Runtime.Routine.ToString().

ToString() [2/2]

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

private

        {
 
            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

        {
 
            if (type == null || type == typeof(void))
                return;
 
            if (type != typeof(int)
                && type != typeof(float)
                && type != typeof(bool)
                && type != typeof(double)
                && 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.");
 
        }

Wird benutzt von ScriptStack.Runtime.Routine.Routine() und ScriptStack.Runtime.Routine.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.

Parameter

parameters

        {
 
            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.");
 
            }
 
        }

Benutzt ScriptStack.Runtime.Routine.name und ScriptStack.Runtime.Routine.parameters.

Wird benutzt von 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.

Parameter

result

        {
 
            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.");
 
        }

Benutzt ScriptStack.Runtime.Routine.name und ScriptStack.Runtime.Routine.result.

Dokumentation der Datenelemente

description

string ScriptStack.Runtime.Routine.description

private

Wird benutzt von ScriptStack.Runtime.Routine.Description() und ScriptStack.Runtime.Routine.Routine().

host

Host ScriptStack.Runtime.Routine.host

private

Wird benutzt von ScriptStack.Runtime.Routine.Routine() und ScriptStack.Runtime.Routine.Routine().

name

string ScriptStack.Runtime.Routine.name

private

Wird benutzt von ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.ToString(), ScriptStack.Runtime.Routine.Verify() und ScriptStack.Runtime.Routine.Verify().

parameters

List<Type> ScriptStack.Runtime.Routine.parameters

private

Wird benutzt von ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.ToString() und ScriptStack.Runtime.Routine.Verify().

result

Type ScriptStack.Runtime.Routine.result

private

Wird benutzt von ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.Routine(), ScriptStack.Runtime.Routine.ToString() und ScriptStack.Runtime.Routine.Verify().

Dokumentation der Propertys

Handler

Host ScriptStack.Runtime.Routine.Handler

getset

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

Wird benutzt von ScriptStack.Runtime.Interpreter.INV().

Name

string ScriptStack.Runtime.Routine.Name

get

        {
            get { return name; }
        }

Wird benutzt von ScriptStack.Runtime.Interpreter.INV().

ParameterTypes

List<Type> ScriptStack.Runtime.Routine.ParameterTypes

get

        {
            get { return parameters; }
        }

Wird benutzt von ScriptStack.Runtime.Interpreter.INV() und ScriptStack.Compiler.Parser.RoutineCall().

Result

Type ScriptStack.Runtime.Routine.Result

get

        {
            get { return result; }
        }

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• C:/Users/manuel/Desktop/doc/Runtime/Routine.cs