Class SourceUnit


  • public class SourceUnit
    extends ProcessingUnit
    Provides an anchor for a single source unit (usually a script file) as it passes through the compiler system.
    • Field Detail

      • source

        protected ReaderSource source
        Where we can get Readers for our source unit
      • name

        protected String 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

        protected Reduction cst
        A Concrete Syntax Tree of the source
      • ast

        protected ModuleNode ast
        The root of the Abstract Syntax Tree for the source
    • Method Detail

      • getName

        public String getName()
        Returns the name for the SourceUnit. This name shouldn't be used for controlling the SourceUnit, it is only for error messages
      • getCST

        public Reduction getCST()
        Returns the Concrete Syntax Tree produced during parse()ing.
      • getAST

        public ModuleNode 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.
      • create

        public static SourceUnit create​(String name,
                                        String source)
        A convenience routine to create a standalone SourceUnit on a String with defaults for almost everything that is configurable.
      • create

        public static SourceUnit create​(String name,
                                        String source,
                                        int tolerance)
        A convenience routine to create a standalone SourceUnit on a String with defaults for almost everything that is configurable.
      • getSample

        public String getSample​(int line,
                                int column,
                                Janitor janitor)
        Returns a sampling of the source at the specified line and column, or null if it is unavailable.
      • addException

        public void addException​(Exception e)
                          throws CompilationFailedException
        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 the ErrorCollector directly by retrieving it with getErrorCollector().
        Parameters:
        e - the exception that occurred
        Throws:
        CompilationFailedException - on error
      • addError

        public void addError​(SyntaxException se)
                      throws CompilationFailedException
        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
      • setSource

        public void setSource​(ReaderSource source)