Package org.ek9lang.compiler.support

Class SymbolFactory

java.lang.Object

org.ek9lang.compiler.support.SymbolFactory

public class SymbolFactory
extends Object

Just a factory for all types of EK9 symbol. Ensures that newly created symbols are initialised correctly.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESSED
static final String	DEFAULTED
static final String	EXTERN
static final String	HTTP_ACCESS
static final String	HTTP_HEADER
static final String	HTTP_PATH
static final String	HTTP_QUERY
static final String	HTTP_REQUEST
static final String	HTTP_SOURCE
static final String	HTTP_VERB
static final String	NO_REFERENCED_RESET
static final String	SUBSTITUTED
static final String	UNINITIALISED_AT_DECLARATION
static final String	URI_PROTO

Constructor Summary

Constructors

Constructor	Description
SymbolFactory(ParsedModule parsedModule)	Create a new symbol factory for use with the parsedModule.

Method Summary

Modifier and Type	Method	Description
boolean	addMissingDefaultOperators(EK9Parser.DefaultOperatorContext ctx, IAggregateSymbol aggregate)	A bit of a beast this method.
void	ensureTextBodyIsInSuper(MethodSymbol textMethodSymbol)	Ensures that any method in a specific text block is always added to the base text for that component.
AggregateFactory	getAggregateFactory()
AggregateSymbol	newApplication(EK9Parser.ApplicationDeclarationContext ctx)	Create a new aggregate that represents an EK9 application.
CallSymbol	newCall(EK9Parser.CallContext ctx, IScope scope)	Symbol to model some type of call to a function, dynamic function, constructor, this, super etc.
AggregateWithTraitsSymbol	newClass(EK9Parser.ClassDeclarationContext ctx)	Create a new aggregate that represents an EK9 class.
AggregateWithTraitsSymbol	newComponent(EK9Parser.ComponentDeclarationContext ctx)	Create a new aggregate that represents an EK9 component.
ConstantSymbol	newConstant(EK9Parser.ConstantDeclarationContext ctx)	Create a new constant as declared in the constants section.
CallSymbol	newDict(EK9Parser.DictContext ctx, IScope scope)	Create a new EK9 Dictionary - like a Map.
CallSymbol	newDictEntry(EK9Parser.InitValuePairContext ctx, IScope scope)	Create a new entry for the Dictionary, basically a tuple.
Directive	newDirective(EK9Parser.DirectiveContext ctx)	Create a new directive to be used inside the compiler.
AggregateWithTraitsSymbol	newDynamicClass(IScopedSymbol enclosingMainTypeOrFunction, EK9Parser.DynamicClassDeclarationContext ctx)	Create a new aggregate that represents an EK9 dynamic class.
FunctionSymbol	newDynamicFunction(IScopedSymbol enclosingMainTypeOrFunction, EK9Parser.DynamicFunctionDeclarationContext ctx)	Create a new aggregate that represents an EK9 dynamic function.
CaptureScope	newDynamicVariableCapture(ICanCaptureVariables scope, IScope enclosingBlockScope)	Create a new local scope just for variables to be defined/captured in for dynamic classes/functions.
ExpressionSymbol	newExpressionSymbol(ISymbol fromSymbol)	Create a new expression around a symbol.
ExpressionSymbol	newExpressionSymbol(IToken token, String name)	Create a new expression symbol place-holder.
ExpressionSymbol	newExpressionSymbol(IToken token, String name, Optional<ISymbol> ofType)	Create a new expression symbol place-holder.
ForSymbol	newForLoop(org.antlr.v4.runtime.ParserRuleContext ctx, IScope scope)	Create a new symbol that represents an EK9 'for' loop.
FunctionSymbol	newFunction(EK9Parser.FunctionDeclarationContext ctx)	Create a new function symbol that represents an EK9 function.
Symbol	newGeneralSymbol(IToken token, String name)	Just for general symbols, like references.
ExpressionSymbol	newInterpolatedExpressionPart(EK9Parser.StringPartContext ctx)	Create a new expression that represents the expression part of and interpolated String.
ConstantSymbol	newInterpolatedStringPart(EK9Parser.StringPartContext ctx, IScope scope)	Create a new constant that represents the fixed text part of an interpolated String.
CallSymbol	newList(EK9Parser.ListContext ctx, IScope scope)	Create a new EK9 List (a generic type).
ConstantSymbol	newLiteral(IToken start, String name)	Create a new aggregate that represents an EK9 literal value.
VariableSymbol	newLoopVariable(EK9Parser.ForLoopContext ctx)	Create a new aggregate that represents an EK9 loop variable.
VariableSymbol	newLoopVariable(EK9Parser.ForRangeContext ctx)	Create a new aggregate that represents an EK9 loop variable for a range.
MethodSymbol	newMethod(EK9Parser.MethodDeclarationContext ctx, String methodName, IScopedSymbol scopedSymbol)	Create a new method with a specific name.
MethodSymbol	newMethod(EK9Parser.MethodDeclarationContext ctx, IScopedSymbol scopedSymbol)	Create a new method that represents an EK9 class/component method.
CallSymbol	newOperationCall(EK9Parser.OperationCallContext ctx, IScope scope)	New call but modelled as an operator if marked as such.
MethodSymbol	newOperator(EK9Parser.OperatorDeclarationContext ctx, IAggregateSymbol aggregate)	Create a new aggregate that represents an EK9 operator, uses a method for this.
AggregateSymbol	newPackage(EK9Parser.PackageBlockContext ctx)	Create a new EK9 package aggregate.
PossibleGenericSymbol	newParameterisedSymbol(PossibleGenericSymbol genericType, List<ISymbol> typeArguments)
AggregateSymbol	newProgram(EK9Parser.MethodDeclarationContext ctx)	Create a new aggregate that represents an EK9 program.
AggregateSymbol	newRecord(EK9Parser.RecordDeclarationContext ctx)	Create a new aggregate that represents an EK9 record.
AggregateSymbol	newService(EK9Parser.ServiceDeclarationContext ctx)	Create a new aggregate that represents an EK9 service.
ServiceOperationSymbol	newServiceOperation(EK9Parser.ServiceOperationDeclarationContext ctx, IScope scope)	Create a new aggregate that represents an EK9 service operation - a specialised method.
StreamPipeLineSymbol	newStream(org.antlr.v4.runtime.ParserRuleContext ctx)	Create a new symbol that represents an EK9 concept of a stream pipeline.
StreamCallSymbol	newStreamCat(EK9Parser.StreamCatContext ctx, IScope scope)	Create a new symbol that represents an EK9 'cat' part of a stream pipeline.
StreamCallSymbol	newStreamFor(EK9Parser.StreamForContext ctx, IScope scope)	Create a new symbol that represents an EK9 'for' part of a stream pipeline.
StreamCallSymbol	newStreamPart(EK9Parser.StreamPartContext ctx, IScope scope)	Create a new symbol that represents an EK9 stream function part of a stream pipeline.
StreamCallSymbol	newStreamTermination(org.antlr.v4.runtime.ParserRuleContext ctx, String operation, IScope scope)	Create a new symbol that represents an EK9 terminal part of a stream pipeline.
SwitchSymbol	newSwitch(EK9Parser.SwitchStatementExpressionContext ctx, IScope scope)	Create a new symbol that represents an EK9 'switch' block.
AggregateSymbol	newText(EK9Parser.TextDeclarationContext ctx, String forLanguage)	Create a new aggregate that represents EK9 text construct.
MethodSymbol	newTextBody(EK9Parser.TextBodyDeclarationContext ctx, IScope scope)	Create a new aggregate that represents an EK9 text body - this is represented by a method.
AggregateWithTraitsSymbol	newTrait(EK9Parser.TraitDeclarationContext ctx)	Create a new aggregate that represents an EK9 trait.
TrySymbol	newTry(EK9Parser.TryStatementExpressionContext ctx, IScope scope)	Create a new symbol that represents an EK9 'try' block.
AggregateSymbol	newType(EK9Parser.TypeDeclarationContext ctx)	Create a new aggregate that represents an EK9 type, constrained or enumeration.
VariableSymbol	newVariable(String name, IToken token, boolean nullAllowed, boolean injectionExpected)	Create new variable typically when looking to create simulated variable.
VariableSymbol	newVariable(EK9Parser.IdentifierContext identifier, boolean nullAllowed, boolean injectionExpected)
VariableSymbol	newVariable(EK9Parser.VariableDeclarationContext ctx)	Create and initialise a new variable symbol.
VariableSymbol	newVariable(EK9Parser.VariableOnlyDeclarationContext ctx)	Just a declaration of a variable by itself - i.e.
WhileSymbol	newWhileLoop(EK9Parser.WhileStatementExpressionContext ctx, IScope scope)	Create a new while or do/while scoped symbol.
void	populateEnumeration(AggregateSymbol enumerationSymbol, List<org.antlr.v4.runtime.tree.TerminalNode> identifiers)	Populates the enumeration with each of the values supplied in the identifiers.

Methods inherited from class java.lang.Object

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

Field Details

UNINITIALISED_AT_DECLARATION

public static final String UNINITIALISED_AT_DECLARATION

See Also:

• Constant Field Values

NO_REFERENCED_RESET

public static final String NO_REFERENCED_RESET

See Also:

• Constant Field Values

SUBSTITUTED

public static final String SUBSTITUTED

See Also:

• Constant Field Values

ACCESSED

public static final String ACCESSED

See Also:

• Constant Field Values

DEFAULTED

public static final String DEFAULTED

See Also:

• Constant Field Values

EXTERN

public static final String EXTERN

See Also:

• Constant Field Values

URI_PROTO

public static final String URI_PROTO

See Also:

• Constant Field Values

HTTP_REQUEST

public static final String HTTP_REQUEST

See Also:

• Constant Field Values

HTTP_PATH

public static final String HTTP_PATH

See Also:

• Constant Field Values

HTTP_HEADER

public static final String HTTP_HEADER

See Also:

• Constant Field Values

HTTP_QUERY

public static final String HTTP_QUERY

See Also:

• Constant Field Values

HTTP_VERB

public static final String HTTP_VERB

See Also:

• Constant Field Values

HTTP_ACCESS

public static final String HTTP_ACCESS

See Also:

• Constant Field Values

HTTP_SOURCE

public static final String HTTP_SOURCE

See Also:

• Constant Field Values

Constructor Details

SymbolFactory

public SymbolFactory(ParsedModule parsedModule)

Create a new symbol factory for use with the parsedModule.

Method Details

getAggregateFactory

public AggregateFactory getAggregateFactory()

newDirective

public Directive newDirective(EK9Parser.DirectiveContext ctx)

Create a new directive to be used inside the compiler.

newPackage

public AggregateSymbol newPackage(EK9Parser.PackageBlockContext ctx)

Create a new EK9 package aggregate.

newProgram

public AggregateSymbol newProgram(EK9Parser.MethodDeclarationContext ctx)

Create a new aggregate that represents an EK9 program.

newClass

public AggregateWithTraitsSymbol newClass(EK9Parser.ClassDeclarationContext ctx)

Create a new aggregate that represents an EK9 class. A bit tricky when it comes to parameterised (generic/template classes).

newComponent

public AggregateWithTraitsSymbol newComponent(EK9Parser.ComponentDeclarationContext ctx)

Create a new aggregate that represents an EK9 component.

newTrait

public AggregateWithTraitsSymbol newTrait(EK9Parser.TraitDeclarationContext ctx)

Create a new aggregate that represents an EK9 trait.

newRecord

public AggregateSymbol newRecord(EK9Parser.RecordDeclarationContext ctx)

Create a new aggregate that represents an EK9 record.

newFunction

public FunctionSymbol newFunction(EK9Parser.FunctionDeclarationContext ctx)

Create a new function symbol that represents an EK9 function.

newText

public AggregateSymbol newText(EK9Parser.TextDeclarationContext ctx,
 String forLanguage)

Create a new aggregate that represents EK9 text construct. Note that this also creates a common base for all text with the same name. It ensures that all methods are added to that common base. Then we can check if all those methods on the common base are also defined in each and every concrete language text aggregate.

newTextBody

public MethodSymbol newTextBody(EK9Parser.TextBodyDeclarationContext ctx,
 IScope scope)

Create a new aggregate that represents an EK9 text body - this is represented by a method.

ensureTextBodyIsInSuper

public void ensureTextBodyIsInSuper(MethodSymbol textMethodSymbol)

Ensures that any method in a specific text block is always added to the base text for that component.

newService

public AggregateSymbol newService(EK9Parser.ServiceDeclarationContext ctx)

Create a new aggregate that represents an EK9 service.

newServiceOperation

public ServiceOperationSymbol newServiceOperation(EK9Parser.ServiceOperationDeclarationContext ctx,
 IScope scope)

Create a new aggregate that represents an EK9 service operation - a specialised method.

newApplication

public AggregateSymbol newApplication(EK9Parser.ApplicationDeclarationContext ctx)

Create a new aggregate that represents an EK9 application.

newDynamicClass

public AggregateWithTraitsSymbol newDynamicClass(IScopedSymbol enclosingMainTypeOrFunction,
 EK9Parser.DynamicClassDeclarationContext ctx)

Create a new aggregate that represents an EK9 dynamic class.

newDynamicFunction

public FunctionSymbol newDynamicFunction(IScopedSymbol enclosingMainTypeOrFunction,
 EK9Parser.DynamicFunctionDeclarationContext ctx)

Create a new aggregate that represents an EK9 dynamic function.

newParameterisedSymbol

public PossibleGenericSymbol newParameterisedSymbol(PossibleGenericSymbol genericType,
 List<ISymbol> typeArguments)

newDynamicVariableCapture

public CaptureScope newDynamicVariableCapture(ICanCaptureVariables scope,
 IScope enclosingBlockScope)

Create a new local scope just for variables to be defined/captured in for dynamic classes/functions.

newOperator

public MethodSymbol newOperator(EK9Parser.OperatorDeclarationContext ctx,
 IAggregateSymbol aggregate)

Create a new aggregate that represents an EK9 operator, uses a method for this.

addMissingDefaultOperators

public boolean addMissingDefaultOperators(EK9Parser.DefaultOperatorContext ctx,
 IAggregateSymbol aggregate)

A bit of a beast this method. Check if operator is not present if so add one in. But as it is used in very early phase of compilation not all types will be known. So here this method just uses the raw name of the method.

newMethod

public MethodSymbol newMethod(EK9Parser.MethodDeclarationContext ctx,
 IScopedSymbol scopedSymbol)

Create a new method that represents an EK9 class/component method.

newMethod

public MethodSymbol newMethod(EK9Parser.MethodDeclarationContext ctx,
 String methodName,
 IScopedSymbol scopedSymbol)

Create a new method with a specific name.

newType

public AggregateSymbol newType(EK9Parser.TypeDeclarationContext ctx)

Create a new aggregate that represents an EK9 type, constrained or enumeration.

populateEnumeration

public void populateEnumeration(AggregateSymbol enumerationSymbol,
 List<org.antlr.v4.runtime.tree.TerminalNode> identifiers)

Populates the enumeration with each of the values supplied in the identifiers. This does check for duplicates and will raise errors if there are any.

newStream

public StreamPipeLineSymbol newStream(org.antlr.v4.runtime.ParserRuleContext ctx)

Create a new symbol that represents an EK9 concept of a stream pipeline.

newStreamCat

public StreamCallSymbol newStreamCat(EK9Parser.StreamCatContext ctx,
 IScope scope)

Create a new symbol that represents an EK9 'cat' part of a stream pipeline.

newStreamFor

public StreamCallSymbol newStreamFor(EK9Parser.StreamForContext ctx,
 IScope scope)

Create a new symbol that represents an EK9 'for' part of a stream pipeline.

newStreamPart

public StreamCallSymbol newStreamPart(EK9Parser.StreamPartContext ctx,
 IScope scope)

Create a new symbol that represents an EK9 stream function part of a stream pipeline.

newStreamTermination

public StreamCallSymbol newStreamTermination(org.antlr.v4.runtime.ParserRuleContext ctx,
 String operation,
 IScope scope)

Create a new symbol that represents an EK9 terminal part of a stream pipeline.

newGeneralSymbol

public Symbol newGeneralSymbol(IToken token,
 String name)

Just for general symbols, like references.

newExpressionSymbol

public ExpressionSymbol newExpressionSymbol(IToken token,
 String name)

Create a new expression symbol place-holder. Really just enables the line of code to be captured and the type that the expression returns.

newExpressionSymbol

public ExpressionSymbol newExpressionSymbol(IToken token,
 String name,
 Optional<ISymbol> ofType)

Create a new expression symbol place-holder. Really just enables the line of code to be captured and the type that the expression returns.

newExpressionSymbol

public ExpressionSymbol newExpressionSymbol(ISymbol fromSymbol)

Create a new expression around a symbol.

newCall

public CallSymbol newCall(EK9Parser.CallContext ctx,
 IScope scope)

Symbol to model some type of call to a function, dynamic function, constructor, this, super etc.

newList

public CallSymbol newList(EK9Parser.ListContext ctx,
 IScope scope)

Create a new EK9 List (a generic type).

newDict

public CallSymbol newDict(EK9Parser.DictContext ctx,
 IScope scope)

Create a new EK9 Dictionary - like a Map.

newDictEntry

public CallSymbol newDictEntry(EK9Parser.InitValuePairContext ctx,
 IScope scope)

Create a new entry for the Dictionary, basically a tuple.

newOperationCall

public CallSymbol newOperationCall(EK9Parser.OperationCallContext ctx,
 IScope scope)

New call but modelled as an operator if marked as such.

newSwitch

public SwitchSymbol newSwitch(EK9Parser.SwitchStatementExpressionContext ctx,
 IScope scope)

Create a new symbol that represents an EK9 'switch' block.

newTry

public TrySymbol newTry(EK9Parser.TryStatementExpressionContext ctx,
 IScope scope)

Create a new symbol that represents an EK9 'try' block.

newForLoop

public ForSymbol newForLoop(org.antlr.v4.runtime.ParserRuleContext ctx,
 IScope scope)

Create a new symbol that represents an EK9 'for' loop.

newWhileLoop

public WhileSymbol newWhileLoop(EK9Parser.WhileStatementExpressionContext ctx,
 IScope scope)

Create a new while or do/while scoped symbol.

newLoopVariable

public VariableSymbol newLoopVariable(EK9Parser.ForLoopContext ctx)

Create a new aggregate that represents an EK9 loop variable.

newLoopVariable

public VariableSymbol newLoopVariable(EK9Parser.ForRangeContext ctx)

Create a new aggregate that represents an EK9 loop variable for a range.

newInterpolatedStringPart

public ConstantSymbol newInterpolatedStringPart(EK9Parser.StringPartContext ctx,
 IScope scope)

Create a new constant that represents the fixed text part of an interpolated String.

newInterpolatedExpressionPart

public ExpressionSymbol newInterpolatedExpressionPart(EK9Parser.StringPartContext ctx)

Create a new expression that represents the expression part of and interpolated String.

newConstant

public ConstantSymbol newConstant(EK9Parser.ConstantDeclarationContext ctx)

Create a new constant as declared in the constants section.

newVariable

public VariableSymbol newVariable(EK9Parser.VariableOnlyDeclarationContext ctx)

Just a declaration of a variable by itself - i.e. without an assignment.

newVariable

public VariableSymbol newVariable(EK9Parser.VariableDeclarationContext ctx)

Create and initialise a new variable symbol. Typically, a variable like name ← "Steve", so 'name' is the variable.

newVariable

public VariableSymbol newVariable(String name,
 IToken token,
 boolean nullAllowed,
 boolean injectionExpected)

Create new variable typically when looking to create simulated variable.

newVariable

public VariableSymbol newVariable(EK9Parser.IdentifierContext identifier,
 boolean nullAllowed,
 boolean injectionExpected)

newLiteral

public ConstantSymbol newLiteral(IToken start,
 String name)

Create a new aggregate that represents an EK9 literal value.