stanhebben.zenscript

Class TypeExpansion

java.lang.Object

stanhebben.zenscript.TypeExpansion

public class TypeExpansion
extends java.lang.Object

Type expansions provide additional members for existing types. They can add members, casters or operators and these will be available to all compiling scripts.

Constructor Summary

Constructors

Constructor and Description
TypeExpansion(java.lang.String type) Creates an empty type expansion.

Method Summary

Modifier and Type	Method and Description
void	addZenExpandMethod(java.lang.String name, ParsedExpansion expansion)
Expression	binary(ZenPosition position, IEnvironmentGlobal environment, Expression left, Expression right, OperatorType operator) Retrieves a binary operator from this expansion.
void	compileAnyCanCastImplicit(ZenType type, MethodOutput output, IEnvironmentGlobal environment, int localClass)
void	compileAnyCast(ZenType type, MethodOutput output, IEnvironmentGlobal environment, int localValue, int localClass)
boolean	compileAnyUnary(MethodOutput output, OperatorType type, IEnvironmentMethod environment)
void	constructCastingRules(IEnvironmentGlobal environment, ICastingRuleDelegate rules) Registers all casting rules to the given delegate.
void	expand(java.lang.Class<?> cls, ITypeRegistry types) Added a native type expansion.
ZenExpandCaster	getCaster(ZenType type, IEnvironmentGlobal environment) Retrieves a caster from this expansion.
IPartialExpression	instanceMember(ZenPosition position, IEnvironmentGlobal environment, Expression value, java.lang.String member) Retrieves an instance member from this expansion.
IPartialExpression	staticMember(ZenPosition position, IEnvironmentGlobal environment, java.lang.String member) Retrieves a static member from this expansion.
Expression	ternary(ZenPosition position, IEnvironmentGlobal environment, Expression first, Expression second, Expression third, OperatorType operator) Retrieves a ternary operator from this expansion.
Expression	unary(ZenPosition position, IEnvironmentGlobal environment, Expression value, OperatorType operator) Retrieves a unary operator from this expansion.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeExpansion

public TypeExpansion(java.lang.String type)

Creates an empty type expansion. Use the expand method to register the actual expansions.

Parameters:

type - type name

Method Detail

expand

public void expand(java.lang.Class<?> cls,
                   ITypeRegistry types)

Added a native type expansion. The provided class must contain the proper annotations for the required expansions, else nothing will happen. Each expansion method must be static and accept the expanded type as first argument.

Parameters:

cls - expanding class

types - type registry

addZenExpandMethod

public void addZenExpandMethod(java.lang.String name,
                               ParsedExpansion expansion)

constructCastingRules

public void constructCastingRules(IEnvironmentGlobal environment,
                                  ICastingRuleDelegate rules)

Registers all casting rules to the given delegate.

Parameters:

environment - compilation environment

rules - target delegate

getCaster

public ZenExpandCaster getCaster(ZenType type,
                                 IEnvironmentGlobal environment)

Retrieves a caster from this expansion. May return null if no suitable caster was available.

Parameters:

type - target type

environment - compilation environment

Returns:

caster, or null if there is no suitable caster

unary

public Expression unary(ZenPosition position,
                        IEnvironmentGlobal environment,
                        Expression value,
                        OperatorType operator)

Retrieves a unary operator from this expansion. May return null if no suitable operator was available.

Parameters:

position - calling position

environment - compile environment

value - argument value

operator - unary operator

Returns:

the resulting expression, or null if no operator was available

binary

public Expression binary(ZenPosition position,
                         IEnvironmentGlobal environment,
                         Expression left,
                         Expression right,
                         OperatorType operator)

Retrieves a binary operator from this expansion. May return null if no suitable operator was available.

Parameters:

position - calling position

environment - compile environment

left - first argument value (left side)

right - second argument value (right side)

operator - binary operator

Returns:

the resulting expression, or null if no operator was available

ternary

public Expression ternary(ZenPosition position,
                          IEnvironmentGlobal environment,
                          Expression first,
                          Expression second,
                          Expression third,
                          OperatorType operator)

Retrieves a ternary operator from this expansion. May return null if no suitable operator was available.

Parameters:

position - calling position

environment - compile environment

first - first argument value

second - second argument value

third - third arugment value

operator - ternary operator

Returns:

the resulting expression, or null if no operator was available

instanceMember

public IPartialExpression instanceMember(ZenPosition position,
                                         IEnvironmentGlobal environment,
                                         Expression value,
                                         java.lang.String member)

Retrieves an instance member from this expansion. May return null if no suitable member was available.

Parameters:

position - calling position

environment - compile environment

value - instance value

member - member name

Returns:

resulting member expression, or null if no such member was available

staticMember

public IPartialExpression staticMember(ZenPosition position,
                                       IEnvironmentGlobal environment,
                                       java.lang.String member)

Retrieves a static member from this expansion. May return null if no suitable member was available.

Parameters:

position - calling position

environment - compile environment

member - member name

Returns:

resulting static member expression, or null if no such member was available

compileAnyCast

public void compileAnyCast(ZenType type,
                           MethodOutput output,
                           IEnvironmentGlobal environment,
                           int localValue,
                           int localClass)

compileAnyCanCastImplicit

public void compileAnyCanCastImplicit(ZenType type,
                                      MethodOutput output,
                                      IEnvironmentGlobal environment,
                                      int localClass)

compileAnyUnary

public boolean compileAnyUnary(MethodOutput output,
                               OperatorType type,
                               IEnvironmentMethod environment)