org.eclipse.golo.compiler

Class GoloCompiler

java.lang.Object

org.eclipse.golo.compiler.GoloCompiler

public final class GoloCompiler
extends java.lang.Object

The Golo compiler.

Instances of this class may be reused to compile several sources.

Several methods are made public while they do not necessarily need so for the needs of the Golo compiler. Such deviations from a "good and clean" design are on-purpose, as this facilitates the implementation of Golo support in IDEs.

Constructor Summary

Constructors

Constructor and Description
GoloCompiler()
GoloCompiler(java.lang.ClassLoader loader)

Method Summary

Modifier and Type	Method and Description
GoloModule	check(ASTCompilationUnit compilationUnit) Checks that the source code is minimally sound by converting a parse tree to an intermediate representation, and running a few classic visitors over it.
java.util.List<CodeGenerationResult>	compile(java.io.File src)
java.util.List<CodeGenerationResult>	compile(java.lang.String goloSourceFilename, java.io.Reader sourceCode) Compiles a Golo source file from an input stream, and returns a collection of results.
GoloModule	expand(GoloModule goloModule)
GoloModule	expand(GoloModule goloModule, boolean recurse)
GoloModule	expandOnce(GoloModule goloModule)
java.util.List<CodeGenerationResult>	generate(GoloModule goloModule)
java.util.List<GoloCompilationException.Problem>	getProblems() Returns the list of problems encountered during the last compilation.
GoloParser	initParser(java.io.Reader sourceReader) Initializes a parser from a reader.
ASTCompilationUnit	parse(java.io.File goloSourceFile)
ASTCompilationUnit	parse(java.lang.String goloSourceFilename, GoloParser parser) Produces a parse tree for a Golo source file.
GoloModule	refine(GoloModule goloModule)
void	resetExceptionBuilder()
void	setExceptionBuilder(GoloCompilationException.Builder builder) Initializes an ExceptionBuilder to collect errors instead of throwing immediately.
GoloModule	transform(ASTCompilationUnit compilationUnit)

Methods inherited from class java.lang.Object

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

Constructor Detail

GoloCompiler

public GoloCompiler()

GoloCompiler

public GoloCompiler(java.lang.ClassLoader loader)

Method Detail

setExceptionBuilder

public void setExceptionBuilder(GoloCompilationException.Builder builder)

Initializes an ExceptionBuilder to collect errors instead of throwing immediately. This method is made public for the requirements of IDEs support.

Parameters:

builder - the exception builder to add problems into.

resetExceptionBuilder

public void resetExceptionBuilder()

initParser

public GoloParser initParser(java.io.Reader sourceReader)

Initializes a parser from a reader. This method is made public for the requirements of IDEs support.

Parameters:

sourceReader - the source code reader.

Returns:

the parser.

compile

public java.util.List<CodeGenerationResult> compile(java.lang.String goloSourceFilename,
                                                    java.io.Reader sourceCode)
                                             throws GoloCompilationException

Compiles a Golo source file from an input stream, and returns a collection of results.

Parameters:

goloSourceFilename - the source file name.

sourceCode - the source code reader.

Returns:

a list of compilation results.

Throws:

GoloCompilationException - if a problem occurs during any phase of the compilation work.

compile

public java.util.List<CodeGenerationResult> compile(java.io.File src)
                                             throws java.io.IOException

Throws:

java.io.IOException

getProblems

public java.util.List<GoloCompilationException.Problem> getProblems()

Returns the list of problems encountered during the last compilation.

Returns:

a list of compilation problems.

parse

public ASTCompilationUnit parse(java.lang.String goloSourceFilename,
                                GoloParser parser)
                         throws GoloCompilationException

Produces a parse tree for a Golo source file. This is mostly useful to IDEs.

Parameters:

goloSourceFilename - the source file name.

parser - the parser to use.

Returns:

the resulting parse tree.

Throws:

GoloCompilationException - if the parser encounters an error.

parse

public ASTCompilationUnit parse(java.io.File goloSourceFile)
                         throws GoloCompilationException,
                                java.io.IOException

Throws:

GoloCompilationException

java.io.IOException

check

public GoloModule check(ASTCompilationUnit compilationUnit)

Checks that the source code is minimally sound by converting a parse tree to an intermediate representation, and running a few classic visitors over it. This is mostly useful to IDEs.

Parameters:

compilationUnit - the source parse tree.

Returns:

the intermediate representation of the source.

Throws:

GoloCompilationException - if an error exists in the source represented by the input parse tree.

generate

public java.util.List<CodeGenerationResult> generate(GoloModule goloModule)

transform

public GoloModule transform(ASTCompilationUnit compilationUnit)

expand

public GoloModule expand(GoloModule goloModule,
                         boolean recurse)

expand

public GoloModule expand(GoloModule goloModule)

expandOnce

public GoloModule expandOnce(GoloModule goloModule)

refine

public GoloModule refine(GoloModule goloModule)