org.millscript.millscript.functions
Class SpiceClassConstructorFunction

java.lang.Object
  org.millscript.millscript.functions.Function
      org.millscript.millscript.functions.SpiceClassConstructorFunction

public class SpiceClassConstructorFunction
extends Function

The Spice class constructor is actually just a normal function that will return an instance of the relevant class.

Constructor Summary

SpiceClassConstructorFunction(SpiceClass sc, Function f)
Constructs a new spice class constructor function for the specified spice class and initialiser function.

Method Summary

void	apply(Machine mc, int nargs) Performs this function using the specified machine, with the specified number of arguments.
Function	getInitialiserFunction() Returns the initialiser function for this constructor.
java.lang.String	toString() Returns a string describing this function as a class, rather than a normal function.

Methods inherited from class org.millscript.millscript.functions.Function

applyUpdater, checkNargs, checkNargsGT, checkUNargs, getName, modName, reportNargsError, reportNargsGTError, setName, tryClone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SpiceClassConstructorFunction

public SpiceClassConstructorFunction(SpiceClass sc,
                                     Function f)

Constructs a new spice class constructor function for the specified spice class and initialiser function.

Parameters:

sc - the spice class we want to construct an instance of

f - the initialiser function for the class

Method Detail

apply

public void apply(Machine mc,
                  int nargs)

Description copied from class: Function

Performs this function using the specified machine, with the specified number of arguments.

Specified by:

apply in class Function

Parameters:

mc - the machine to perform this function on

nargs - the number of arguments the function is being invoked with

See Also:

Function.apply(org.millscript.millscript.vm.Machine, int)

getInitialiserFunction

public Function getInitialiserFunction()

Returns the initialiser function for this constructor.

Returns:

the initialiser Function for this constructor

toString

public java.lang.String toString()

Returns a string describing this function as a class, rather than a normal function.

Overrides:

toString in class Function

Returns:

a String describing this class

See Also:

Object.toString()