org.eclipse.golo.compiler

Class GoloCompiler

java.lang.Object

org.eclipse.golo.compiler.GoloCompiler

public 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()

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.lang.String goloSourceFilename, java.io.InputStream sourceCodeInputStream) Compiles a Golo source file from an input stream, and returns a collection of results.
void	compileTo(java.lang.String goloSourceFilename, java.io.InputStream sourceCodeInputStream, java.io.File targetFolder) Compiles a Golo source file and writes the resulting JVM bytecode .class files to a target folder.
void	compileToJar(java.lang.String goloSourceFilename, java.io.InputStream sourceCodeInputStream, java.util.jar.JarOutputStream jarOutputStream) Compiles a Golo source fila and writes the resulting JVM bytecode .class files to a Jar file stream.
protected GoloParser	createGoloParser(java.io.Reader sourceReader) Makes a Golo parser from a reader.
java.util.List<CodeGenerationResult>	generate(GoloModule goloModule, java.lang.String goloSourceFilename)
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.
GoloParser	initParser(java.lang.String goloSourceFilename, java.io.InputStream sourceCodeInputStream) Initializes a parser from an input stream.
ASTCompilationUnit	parse(java.lang.String goloSourceFilename)
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()

Method Detail

setExceptionBuilder

public final 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 final GoloParser initParser(java.lang.String goloSourceFilename,
                                   java.io.InputStream sourceCodeInputStream)
                            throws GoloCompilationException

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

Parameters:

sourceCodeInputStream - the source code input stream.

Returns:

the parser.

Throws:

GoloCompilationException

initParser

public final 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 final java.util.List<CodeGenerationResult> compile(java.lang.String goloSourceFilename,
                                                          java.io.InputStream sourceCodeInputStream)
                                                   throws GoloCompilationException

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

Parameters:

goloSourceFilename - the source file name.

sourceCodeInputStream - the source code input stream.

Returns:

a list of compilation results.

Throws:

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

getProblems

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

Returns the list of problems encountered during the last compilation

Returns:

a list of compilation problems.

compileTo

public final void compileTo(java.lang.String goloSourceFilename,
                            java.io.InputStream sourceCodeInputStream,
                            java.io.File targetFolder)
                     throws GoloCompilationException,
                            java.io.IOException

Compiles a Golo source file and writes the resulting JVM bytecode .class files to a target folder. The class files are written in a directory structure that respects package names.

Parameters:

goloSourceFilename - the source file name.

sourceCodeInputStream - the source code input stream.

targetFolder - the output target folder.

Throws:

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

java.io.IOException - if writing the .class files fails for some reason.

compileToJar

public final void compileToJar(java.lang.String goloSourceFilename,
                               java.io.InputStream sourceCodeInputStream,
                               java.util.jar.JarOutputStream jarOutputStream)
                        throws java.io.IOException

Compiles a Golo source fila and writes the resulting JVM bytecode .class files to a Jar file stream. The class files are written in a directory structure that respects package names.

Parameters:

goloSourceFilename - the source file name.

sourceCodeInputStream - the source code input stream.

jarOutputStream - the output Jar stream

Throws:

java.io.IOException - if writing the .class files fails for some reason.

parse

public final 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 final ASTCompilationUnit parse(java.lang.String goloSourceFilename)
                               throws GoloCompilationException,
                                      java.io.IOException

Throws:

GoloCompilationException

java.io.IOException

check

public final 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 final java.util.List<CodeGenerationResult> generate(GoloModule goloModule,
                                                           java.lang.String goloSourceFilename)

transform

public final GoloModule transform(ASTCompilationUnit compilationUnit)

refine

public final GoloModule refine(GoloModule goloModule)

createGoloParser

protected GoloParser createGoloParser(java.io.Reader sourceReader)

Makes a Golo parser from a reader.

Parameters:

sourceReader - the reader.

Returns:

the parser for sourceReader.