Package org.eclipse.epsilon.eol

Class EolModule

java.lang.Object

org.eclipse.epsilon.common.module.AbstractModuleElement

org.eclipse.epsilon.eol.AbstractModule

org.eclipse.epsilon.eol.EolModule

All Implemented Interfaces:

IModule, ModuleElement, IEolModule

Direct Known Subclasses:

EglModule, EolModuleParallel, ErlModule, EUnitModule, EwlModule, HutnModule

public class EolModule
extends AbstractModule
implements IEolModule

Field Summary

Fields

Modifier and Type	Field	Description
protected IEolContext	context
protected List<ModelDeclaration>	declaredModelDeclarations
protected OperationList	declaredOperations
protected List<Import>	imports
protected StatementBlock	main
protected Set<ModelDeclaration>	modelDeclarations
protected OperationList	operations
protected List<Statement>	postOperationStatements

Fields inherited from class org.eclipse.epsilon.eol.AbstractModule

parseProblems, parser, sourceFile, sourceUri

Fields inherited from class org.eclipse.epsilon.common.module.AbstractModuleElement

children, comments, data, module, region, uri

Constructor Summary

Constructors

Constructor	Description
EolModule()
EolModule(IEolContext context)	Instantiates the module with the specified execution context.

Method Summary

Modifier and Type	Method	Description
ModuleElement	adapt(AST cst, ModuleElement parentAst)
void	build(AST cst, IModule module)
protected void	checkImports(AST cst)
void	clearCache()	Clear all cached results and type information, and all extended properties.
EolDebugger	createDebugger()	Creates an object that implements debugging (i.e.
protected org.antlr.runtime.Lexer	createLexer(org.antlr.runtime.ANTLRInputStream inputStream)
EpsilonParser	createParser(org.antlr.runtime.TokenStream tokenStream)
Object	execute()
Object	executeImpl()
IEolContext	getContext()
List<ModelDeclaration>	getDeclaredModelDeclarations()
OperationList	getDeclaredOperations()
protected HashMap<String,Class<? extends IModule>>	getImportConfiguration()
IImportManager	getImportManager()	Returns an object that caches the imports made by a module.
List<Import>	getImports()
protected Collection<Import>	getImportsByExtension(AST cst, String extension, Class<? extends IModule> moduleImplClass)
StatementBlock	getMain()
String	getMainRule()
Set<ModelDeclaration>	getModelDeclarations()
OperationList	getOperations()
IEolModule	getParentModule()
List<Statement>	getPostOperationStatements()
protected void	prepareContext()
void	setContext(IEolContext context)
void	setImportManager(IImportManager importManager)	Sets the object that will cache imports to be done by a module.
void	setMain(StatementBlock main)
void	setParentModule(IEolModule parent)
String	toString()

Methods inherited from class org.eclipse.epsilon.eol.AbstractModule

assignAnnotations, assignComment, assignComments, createAst, extractComments, getParseProblems, getSourceFile, getSourceUri, invokeMainRule, parse, parse

Methods inherited from class org.eclipse.epsilon.common.module.AbstractModuleElement

equals, getChildren, getComments, getData, getDebugInfo, getFile, getModule, getParent, getRegion, getUri, hashCode, setModule, setParent, setRegion, setUri

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.epsilon.eol.IEolModule

configure, getConfigurationProperties, getParseProblems, parse

Methods inherited from interface org.eclipse.epsilon.common.module.IModule

createAst, getSourceUri, parse, parse, parse, parse, parse

Methods inherited from interface org.eclipse.epsilon.common.module.ModuleElement

getChildren, getComments, getData, getFile, getModule, getParent, getRegion, getUri, setModule, setParent, setRegion, setUri

Field Details

main

protected StatementBlock main

context

protected IEolContext context

postOperationStatements

protected List<Statement> postOperationStatements

declaredOperations

protected OperationList declaredOperations

imports

protected List<Import> imports

operations

protected OperationList operations

declaredModelDeclarations

protected List<ModelDeclaration> declaredModelDeclarations

modelDeclarations

protected Set<ModelDeclaration> modelDeclarations

Constructor Details

EolModule

public EolModule()

EolModule

public EolModule(IEolContext context)

Instantiates the module with the specified execution context.

Parameters:

context - The execution context

Since:

1.6

Method Details

build

public void build(AST cst,
 IModule module)

Specified by:

build in interface ModuleElement

Overrides:

build in class AbstractModuleElement

adapt

public ModuleElement adapt(AST cst,
 ModuleElement parentAst)

Specified by:

adapt in class AbstractModule

createLexer

protected org.antlr.runtime.Lexer createLexer(org.antlr.runtime.ANTLRInputStream inputStream)

Specified by:

createLexer in class AbstractModule

createParser

public EpsilonParser createParser(org.antlr.runtime.TokenStream tokenStream)

Specified by:

createParser in class AbstractModule

getMainRule

public String getMainRule()

Specified by:

getMainRule in class AbstractModule

getDeclaredOperations

public OperationList getDeclaredOperations()

Specified by:

getDeclaredOperations in interface IEolModule

getImportConfiguration

protected HashMap<String,Class<? extends IModule>> getImportConfiguration()

prepareContext

protected void prepareContext()
                       throws EolRuntimeException

Throws:

EolRuntimeException

getImports

public List<Import> getImports()

Specified by:

getImports in interface IEolModule

toString

public String toString()

Overrides:

toString in class AbstractModuleElement

getModelDeclarations

public Set<ModelDeclaration> getModelDeclarations()

Specified by:

getModelDeclarations in interface IEolModule

getOperations

public OperationList getOperations()

Specified by:

getOperations in interface IEolModule

getImportsByExtension

protected Collection<Import> getImportsByExtension(AST cst,
 String extension,
 Class<? extends IModule> moduleImplClass)

checkImports

protected void checkImports(AST cst)

getDeclaredModelDeclarations

public List<ModelDeclaration> getDeclaredModelDeclarations()

Specified by:

getDeclaredModelDeclarations in interface IEolModule

getParentModule

public IEolModule getParentModule()

Specified by:

getParentModule in interface IEolModule

setParentModule

public void setParentModule(IEolModule parent)

Specified by:

setParentModule in interface IEolModule

execute

public Object execute()
               throws EolRuntimeException

Specified by:

execute in interface IEolModule

Throws:

EolRuntimeException

executeImpl

public Object executeImpl()
                   throws EolRuntimeException

Throws:

EolRuntimeException

getPostOperationStatements

public List<Statement> getPostOperationStatements()

Specified by:

getPostOperationStatements in interface IEolModule

getMain

public StatementBlock getMain()

Specified by:

getMain in interface IEolModule

setMain

public void setMain(StatementBlock main)

getContext

public IEolContext getContext()

Specified by:

getContext in interface IEolModule

setContext

public void setContext(IEolContext context)

Specified by:

setContext in interface IEolModule

clearCache

public void clearCache()

Clear all cached results and type information, and all extended properties. Useful for rerunning the same EolModule with different sets of models, without having to parse it again.

getImportManager

public IImportManager getImportManager()

Description copied from interface: IEolModule

Returns an object that caches the imports made by a module.

Specified by:

getImportManager in interface IEolModule

setImportManager

public void setImportManager(IImportManager importManager)

Description copied from interface: IEolModule

Sets the object that will cache imports to be done by a module.

Specified by:

setImportManager in interface IEolModule

createDebugger

public EolDebugger createDebugger()

Description copied from interface: IEolModule

Creates an object that implements debugging (i.e. breakpoints and stepping) for this module.

Specified by:

createDebugger in interface IEolModule