polyglot.ast

Class SourceFile_c

java.lang.Object

polyglot.ast.Node_c

polyglot.ast.SourceFile_c

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Node, NodeOps, SourceFile, Copy<Node>

public class SourceFile_c
extends Node_c
implements SourceFile

A SourceFile is an immutable representations of a Java language source file. It consists of a package name, a list of Imports, and a list of GlobalDecls.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface polyglot.util.Copy

Copy.Util

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<TopLevelDecl>	decls
protected java.util.List<Import>	imports
protected ImportTable	importTable
protected PackageNode	package_
protected Source	source

Fields inherited from class polyglot.ast.Node_c

del, error, ext, position

Constructor Summary

Constructors

Constructor and Description
SourceFile_c(Position pos, PackageNode package_, java.util.List<Import> imports, java.util.List<TopLevelDecl> decls)
SourceFile_c(Position pos, PackageNode package_, java.util.List<Import> imports, java.util.List<TopLevelDecl> decls, Ext ext)

Method Summary

Methods

Modifier and Type	Method and Description
Node	buildTypes(TypeBuilder tb) Collects classes, methods, and fields from the AST rooted at this node and constructs type objects for these.
NodeVisitor	buildTypesEnter(TypeBuilder tb) Build type objects for the source file.
Node	copy(NodeFactory nf) Produce a copy of this node using the given NodeFactory.
java.util.List<TopLevelDecl>	decls() Get the source's top-level declarations.
SourceFile	decls(java.util.List<TopLevelDecl> decls) Set the source's top-level declarations.
protected <N extends SourceFile_c> N	decls(N n, java.util.List<TopLevelDecl> decls)
Node	disambiguateOverride(Node parent, AmbiguityRemover ar) Disambiguate the AST.
void	dump(CodeWriter w) Dump the AST node for debugging purposes.
Context	enterScope(Context c) Push a new scope upon entering this node, and add any declarations to the context that should be in scope when visiting children of this node.
Node	extRewrite(ExtensionRewriter rw) Rewrite the AST for the compilation in this language.
java.util.List<Import>	imports() Get the source's declared imports.
SourceFile	imports(java.util.List<Import> imports) Set the source's declared imports.
protected <N extends SourceFile_c> N	imports(N n, java.util.List<Import> imports)
ImportTable	importTable() Get the source's import table.
SourceFile	importTable(ImportTable importTable) Set the source's import table.
protected <N extends SourceFile_c> N	importTable(N n, ImportTable importTable)
boolean	isDisambiguated()
PackageNode	package_() Get the source's declared package.
protected <N extends SourceFile_c> N	package_(N n, PackageNode package_)
SourceFile	package_(PackageNode package_) Set the source's declared package.
void	prettyPrint(CodeWriter w, PrettyPrinter tr) Pretty-print the AST using the given CodeWriter.
protected <N extends SourceFile_c> N	reconstruct(N n, PackageNode package_, java.util.List<Import> imports, java.util.List<TopLevelDecl> decls) Reconstruct the source file.
Source	source() Get the source file.
protected <N extends SourceFile_c> N	source(N n, Source source)
SourceFile	source(Source source) Set the source file.
java.lang.String	toString()
Node	typeCheck(TypeChecker tc) Type check the AST.
Node	visitChildren(NodeVisitor v) Visit the children of the node.

Methods inherited from class polyglot.ast.Node_c

addDecls, checkConstants, childExpectedType, copy, copy, copyIfNeeded, del, del, disambiguate, disambiguateEnter, dump, dump, dump, dump, enterChildScope, error, error, error, exceptionCheck, exceptionCheckEnter, ext, ext, ext, ext, extRewriteEnter, isTypeChecked, lang, position, position, position, prettyPrint, prettyPrint, prettyPrint, prettyPrint, print, printBlock, printSubStmt, throwTypes, translate, typeCheckEnter, typeCheckOverride, visit, visitChild, visitEdge, visitList

Methods inherited from class java.lang.Object

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

Methods inherited from interface polyglot.ast.Node

del, del, error, error, ext, ext, ext, ext, isTypeChecked, position, position, visit, visitEdge

Methods inherited from interface polyglot.ast.NodeOps

addDecls, checkConstants, childExpectedType, copy, disambiguate, disambiguateEnter, dump, dump, dump, dump, enterChildScope, exceptionCheck, exceptionCheckEnter, extRewriteEnter, lang, prettyPrint, prettyPrint, prettyPrint, prettyPrint, throwTypes, translate, typeCheckEnter, typeCheckOverride, visitChild, visitList

Methods inherited from interface polyglot.util.Copy

copy

Field Detail

package_

protected PackageNode package_

imports

protected java.util.List<Import> imports

decls

protected java.util.List<TopLevelDecl> decls

importTable

protected ImportTable importTable

source

protected Source source

Constructor Detail

SourceFile_c

public SourceFile_c(Position pos,
            PackageNode package_,
            java.util.List<Import> imports,
            java.util.List<TopLevelDecl> decls)

SourceFile_c

public SourceFile_c(Position pos,
            PackageNode package_,
            java.util.List<Import> imports,
            java.util.List<TopLevelDecl> decls,
            Ext ext)

Method Detail

isDisambiguated

public boolean isDisambiguated()

Specified by:

isDisambiguated in interface Node

Overrides:

isDisambiguated in class Node_c

Returns:

true if the all type information for the node (but not necessarily for the node's children) is unambiguous.

source

public Source source()

Description copied from interface: SourceFile

Get the source file.

Specified by:

source in interface SourceFile

source

public SourceFile source(Source source)

Description copied from interface: SourceFile

Set the source file.

Specified by:

source in interface SourceFile

source

protected <N extends SourceFile_c> N source(N n,
                                Source source)

package_

public PackageNode package_()

Description copied from interface: SourceFile

Get the source's declared package.

Specified by:

package_ in interface SourceFile

package_

public SourceFile package_(PackageNode package_)

Description copied from interface: SourceFile

Set the source's declared package.

Specified by:

package_ in interface SourceFile

package_

protected <N extends SourceFile_c> N package_(N n,
                                  PackageNode package_)

imports

public java.util.List<Import> imports()

Description copied from interface: SourceFile

Get the source's declared imports.

Specified by:

imports in interface SourceFile

Returns:

A list of Import.

imports

public SourceFile imports(java.util.List<Import> imports)

Description copied from interface: SourceFile

Set the source's declared imports.

Specified by:

imports in interface SourceFile

Parameters:

imports - A list of Import.

imports

protected <N extends SourceFile_c> N imports(N n,
                                 java.util.List<Import> imports)

decls

public java.util.List<TopLevelDecl> decls()

Description copied from interface: SourceFile

Get the source's top-level declarations.

Specified by:

decls in interface SourceFile

Returns:

A list of TopLevelDecl.

decls

public SourceFile decls(java.util.List<TopLevelDecl> decls)

Description copied from interface: SourceFile

Set the source's top-level declarations.

Specified by:

decls in interface SourceFile

Parameters:

decls - A list of TopLevelDecl.

decls

protected <N extends SourceFile_c> N decls(N n,
                               java.util.List<TopLevelDecl> decls)

importTable

public ImportTable importTable()

Description copied from interface: SourceFile

Get the source's import table.

Specified by:

importTable in interface SourceFile

importTable

public SourceFile importTable(ImportTable importTable)

Description copied from interface: SourceFile

Set the source's import table.

Specified by:

importTable in interface SourceFile

importTable

protected <N extends SourceFile_c> N importTable(N n,
                                     ImportTable importTable)

reconstruct

protected <N extends SourceFile_c> N reconstruct(N n,
                                     PackageNode package_,
                                     java.util.List<Import> imports,
                                     java.util.List<TopLevelDecl> decls)

Reconstruct the source file.

visitChildren

public Node visitChildren(NodeVisitor v)

Description copied from interface: NodeOps

Visit the children of the node.

Specified by:

visitChildren in interface NodeOps

Overrides:

visitChildren in class Node_c

Parameters:

v - The visitor that will traverse/rewrite the AST.

Returns:

A new AST if a change was made, or this.

buildTypesEnter

public NodeVisitor buildTypesEnter(TypeBuilder tb)
                            throws SemanticException

Build type objects for the source file. Set the visitor's import table field before we recurse into the declarations.

Specified by:

buildTypesEnter in interface NodeOps

Overrides:

buildTypesEnter in class Node_c

Parameters:

tb - The visitor which adds new type objects to the TypeSystem.

Throws:

SemanticException

buildTypes

public Node buildTypes(TypeBuilder tb)
                throws SemanticException

Description copied from interface: NodeOps

Collects classes, methods, and fields from the AST rooted at this node and constructs type objects for these. These type objects may be ambiguous. Inserts classes into the TypeSystem. This method is called by the leave() method of the visitor. The method should perform work that should be done after visiting the children of the node. The method may return this or a new copy of the node which will be installed as a child of the node's parent.

Specified by:

buildTypes in interface NodeOps

Overrides:

buildTypes in class Node_c

Parameters:

tb - The visitor which adds new type objects to the TypeSystem.

Throws:

SemanticException

enterScope

public Context enterScope(Context c)

Description copied from class: Node_c

Push a new scope upon entering this node, and add any declarations to the context that should be in scope when visiting children of this node.

Specified by:

enterScope in interface NodeOps

Overrides:

enterScope in class Node_c

Parameters:

c - the current Context

Returns:

the Context to be used for visiting this node.

typeCheck

public Node typeCheck(TypeChecker tc)
               throws SemanticException

Description copied from interface: NodeOps

Type check the AST. This method is called by the leave() method of the visitor. The method should perform work that should be done after visiting the children of the node. The method may return this or a new copy of the node which will be installed as a child of the node's parent.

Specified by:

typeCheck in interface NodeOps

Overrides:

typeCheck in class Node_c

Parameters:

tc - The type checking visitor.

Throws:

SemanticException

extRewrite

public Node extRewrite(ExtensionRewriter rw)
                throws SemanticException

Description copied from interface: NodeOps

Rewrite the AST for the compilation in this language. This method is called by the leave() method of the visitor. The method should perform work that should be done after visiting the children of the node. The method may return this or a new copy of the node which will be installed as a child of the node's parent.

Specified by:

extRewrite in interface NodeOps

Overrides:

extRewrite in class Node_c

Parameters:

rw - The visitor.

Throws:

SemanticException

toString

public java.lang.String toString()

Overrides:

toString in class Node_c

prettyPrint

public void prettyPrint(CodeWriter w,
               PrettyPrinter tr)

Description copied from class: Node_c

Pretty-print the AST using the given CodeWriter.

Specified by:

prettyPrint in interface NodeOps

Overrides:

prettyPrint in class Node_c

Parameters:

w - The code writer to which to write.

tr - The pretty printer. This is not a visitor.

disambiguateOverride

public Node disambiguateOverride(Node parent,
                        AmbiguityRemover ar)
                          throws SemanticException

Description copied from interface: NodeOps

Disambiguate the AST. This method is called by the override() method of the visitor. If this method returns non-null, the node's children will not be visited automatically. Thus, the method should check both the node this and it's children, usually by invoking visitChildren with tc or with another visitor, returning a non-null node. OR, the method should do nothing and simply return null to allow enter, visitChildren, and leave to be invoked on the node. The default implementation returns null. Overriding of this method is discouraged, but sometimes necessary.

Specified by:

disambiguateOverride in interface NodeOps

Overrides:

disambiguateOverride in class Node_c

ar - The visitor which disambiguates.

Throws:

SemanticException

dump

public void dump(CodeWriter w)

Description copied from interface: Node

Dump the AST node for debugging purposes.

Specified by:

dump in interface Node

Overrides:

dump in class Node_c

copy

public Node copy(NodeFactory nf)

Description copied from interface: NodeOps

Produce a copy of this node using the given NodeFactory.

Specified by:

copy in interface NodeOps

Overrides:

copy in class Node_c