Package org.codehaus.groovy.control
Class SourceUnit
java.lang.Object
org.codehaus.groovy.control.ProcessingUnit
org.codehaus.groovy.control.SourceUnit
Provides an anchor for a single source unit (usually a script file)
as it passes through the compiler system.
- Author:
- Chris Poirier, Bing Ran
-
Field Summary
Modifier and TypeFieldDescriptionprotected ModuleNode
The root of the Abstract Syntax Tree for the sourceprotected Reduction
A Concrete Syntax Tree of the sourceprotected String
A descriptive name of the source unit.protected ReaderSource
Where we can get Readers for our source unitFields inherited from class org.codehaus.groovy.control.ProcessingUnit
classLoader, configuration, errorCollector, phase, phaseComplete
-
Constructor Summary
ConstructorDescriptionSourceUnit
(File source, CompilerConfiguration configuration, GroovyClassLoader loader, ErrorCollector er) Initializes the SourceUnit from the specified file.SourceUnit
(String name, String source, CompilerConfiguration configuration, GroovyClassLoader loader, ErrorCollector er) Initializes the SourceUnit for a string of source.SourceUnit
(String name, ReaderSource source, CompilerConfiguration flags, GroovyClassLoader loader, ErrorCollector er) Initializes the SourceUnit from existing machinery.SourceUnit
(URL source, CompilerConfiguration configuration, GroovyClassLoader loader, ErrorCollector er) Initializes the SourceUnit from the specified URL. -
Method Summary
Modifier and TypeMethodDescriptionvoid
This method adds a SyntaxException to the error collector.void
This method adds an exception to the error collector.void
convert()
Generates an AST from the CST.static SourceUnit
A convenience routine to create a standalone SourceUnit on a String with defaults for almost everything that is configurable.static SourceUnit
A convenience routine to create a standalone SourceUnit on a String with defaults for almost everything that is configurable.boolean
Convenience routine, primarily for use by the InteractiveShell, that returns true if parse() failed with an unexpected EOF.getAST()
Returns the Abstract Syntax Tree produced during convert()ing and expanded during later phases.getCST()
Returns the Concrete Syntax Tree produced during parse()ing.getName()
Returns the name for the SourceUnit.Returns a sampling of the source at the specified line and column, or null if it is unavailable.protected boolean
isEofToken
(antlr.Token token) void
parse()
Parses the source to a CST.Methods inherited from class org.codehaus.groovy.control.ProcessingUnit
completePhase, configure, getClassLoader, getConfiguration, getErrorCollector, getPhase, getPhaseDescription, gotoPhase, nextPhase, setClassLoader, setConfiguration
-
Field Details
-
source
Where we can get Readers for our source unit -
name
A descriptive name of the source unit. This name shouldn't be used for controlling the SourceUnit, it is only for error messages and to determine the name of the class for a script. -
cst
A Concrete Syntax Tree of the source -
ast
The root of the Abstract Syntax Tree for the source
-
-
Constructor Details
-
SourceUnit
public SourceUnit(String name, ReaderSource source, CompilerConfiguration flags, GroovyClassLoader loader, ErrorCollector er) Initializes the SourceUnit from existing machinery. -
SourceUnit
public SourceUnit(File source, CompilerConfiguration configuration, GroovyClassLoader loader, ErrorCollector er) Initializes the SourceUnit from the specified file. -
SourceUnit
public SourceUnit(URL source, CompilerConfiguration configuration, GroovyClassLoader loader, ErrorCollector er) Initializes the SourceUnit from the specified URL. -
SourceUnit
public SourceUnit(String name, String source, CompilerConfiguration configuration, GroovyClassLoader loader, ErrorCollector er) Initializes the SourceUnit for a string of source.
-
-
Method Details
-
getName
Returns the name for the SourceUnit. This name shouldn't be used for controlling the SourceUnit, it is only for error messages -
getCST
Returns the Concrete Syntax Tree produced during parse()ing. -
getAST
Returns the Abstract Syntax Tree produced during convert()ing and expanded during later phases. -
failedWithUnexpectedEOF
public boolean failedWithUnexpectedEOF()Convenience routine, primarily for use by the InteractiveShell, that returns true if parse() failed with an unexpected EOF. -
isEofToken
protected boolean isEofToken(antlr.Token token) -
create
A convenience routine to create a standalone SourceUnit on a String with defaults for almost everything that is configurable. -
create
A convenience routine to create a standalone SourceUnit on a String with defaults for almost everything that is configurable. -
parse
Parses the source to a CST. You can retrieve it with getCST().- Throws:
CompilationFailedException
-
convert
Generates an AST from the CST. You can retrieve it with getAST().- Throws:
CompilationFailedException
-
getSample
Returns a sampling of the source at the specified line and column, or null if it is unavailable. -
addException
This method adds an exception to the error collector. The Exception most likely has no line number attached to it. For this reason you should use this method sparingly. Prefer using addError for syntax errors or add an error to theErrorCollector
directly by retrieving it with getErrorCollector().- Parameters:
e
- the exception that occurred- Throws:
CompilationFailedException
- on error
-
addError
This method adds a SyntaxException to the error collector. The exception should specify the line and column number of the error. This method should be reserved for real errors in the syntax of the SourceUnit. If your error is not in syntax, and is a semantic error, or more general error, then use addException or use the error collector directly by retrieving it with getErrorCollector().- Parameters:
se
- the exception, which should have line and column information- Throws:
CompilationFailedException
- on error
-
getSource
-