polyglot.ast

Class Ext_c

java.lang.Object

polyglot.ast.Ext_c

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Ext, NodeOps, Copy<Ext>

Direct Known Subclasses:

JL5Ext, JL7Ext, ToExt_c

public abstract class Ext_c
extends java.lang.Object
implements Ext

Ext is the super type of all node extension objects. It contains a pointer back to the node it is extending and a possibly-null pointer to another extension node.

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 Ext	ext
protected Node	node
protected NodeOps	pred

Constructor Summary

Constructors

Constructor and Description
Ext_c()
Ext_c(Ext ext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDecls(Context c) Add any declarations to the context that should be in scope when visiting later sibling nodes.
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) Collects classes, methods, and fields from the AST rooted at this node and constructs type objects for these.
Node	checkConstants(ConstantChecker cc) Check if the node is a compile-time constant.
Type	childExpectedType(Expr child, AscriptionVisitor av) Get the expected type of a child expression of this.
Ext	copy()
Node	copy(ExtensionInfo extInfo) Produce a copy of this node using the given ExtensionInfo.
Node	copy(NodeFactory nf) Produce a copy of this node using the given NodeFactory.
Node	disambiguate(AmbiguityRemover ar) Remove any remaining ambiguities from the AST.
NodeVisitor	disambiguateEnter(AmbiguityRemover ar) Remove any remaining ambiguities from the AST.
Node	disambiguateOverride(Node parent, AmbiguityRemover ar) Disambiguate the AST.
void	dump(CodeWriter w) Dump the AST node for debugging purposes.
void	dump(Lang lang, java.io.OutputStream os) Dump the AST for debugging.
void	dump(Lang lang, java.io.Writer w) Dump the AST for debugging.
void	dump(java.io.OutputStream os) Deprecated.
void	dump(java.io.Writer w) Deprecated.
Context	enterChildScope(Node child, Context c) Push a new scope for visiting the child node child.
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	exceptionCheck(ExceptionChecker ec) Check that exceptions are properly propagated throughout the AST.
NodeVisitor	exceptionCheckEnter(ExceptionChecker ec) Check that exceptions are properly propagated throughout the AST.
Ext	ext() An extension of this extension, or null.
Ext	ext(Ext ext) Set the extension of this extension.
Node	extRewrite(ExtensionRewriter rw) Rewrite the AST for the compilation in this language.
NodeVisitor	extRewriteEnter(ExtensionRewriter rw) Rewrite the AST for the compilation in this language.
void	init(Node node) Initialize the extension object's pointer back to the node.
void	initPred(NodeOps pred) Initialize the extension object's pointer back to the parent.
Lang	lang() The language defined by this NodeOps implementation.
Node	node() The node we ultimately extend.
NodeOps	pred() The parent of this extension.
void	prettyPrint(CodeWriter w, PrettyPrinter pp) Pretty-print the AST using the given CodeWriter.
void	prettyPrint(Lang lang, java.io.OutputStream os) Pretty-print the AST for debugging.
void	prettyPrint(Lang lang, java.io.Writer w) Pretty-print the AST for debugging.
void	prettyPrint(java.io.OutputStream os) Deprecated.
void	prettyPrint(java.io.Writer w) Deprecated.
void	print(Node child, CodeWriter w, PrettyPrinter pp)
void	printBlock(Node n, CodeWriter w, PrettyPrinter pp)
void	printSubStmt(Stmt stmt, CodeWriter w, PrettyPrinter pp)
protected JLang	superLang()
java.util.List<Type>	throwTypes(TypeSystem ts) List of Types of exceptions that might get thrown.
java.lang.String	toString()
void	translate(CodeWriter w, Translator tr) Translate the AST using the given CodeWriter.
Node	typeCheck(TypeChecker tc) Type check the AST.
NodeVisitor	typeCheckEnter(TypeChecker tc) Type check the AST.
Node	typeCheckOverride(Node parent, TypeChecker tc) Type check the AST.
<N extends Node> N	visitChild(N child, NodeVisitor v) Visit a single child of the node.
Node	visitChildren(NodeVisitor v) Visit the children of the node.
<N extends Node> java.util.List<N>	visitList(java.util.List<N> l, NodeVisitor v) Visit all the elements of a list.

Methods inherited from class java.lang.Object

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

Field Detail

node

protected Node node

pred

protected NodeOps pred

ext

protected Ext ext

Constructor Detail

Ext_c

public Ext_c()

Ext_c

public Ext_c(Ext ext)

Method Detail

lang

public Lang lang()

Description copied from interface: NodeOps

The language defined by this NodeOps implementation.

Specified by:

lang in interface NodeOps

superLang

protected final JLang superLang()

visitChild

public <N extends Node> N visitChild(N child,
                            NodeVisitor v)

Description copied from interface: NodeOps

Visit a single child of the node.

Specified by:

visitChild in interface NodeOps

Parameters:

child - The child to visit.

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

Returns:

The result of child.visit(v), or null if child was null.

visitList

public <N extends Node> java.util.List<N> visitList(java.util.List<N> l,
                                           NodeVisitor v)

Description copied from interface: NodeOps

Visit all the elements of a list.

Specified by:

visitList in interface NodeOps

Parameters:

l - The list to visit.

v - The visitor to use.

Returns:

A new list with each element from the old list replaced by the result of visiting that element. If l is null, null is returned.

node

public Node node()

Description copied from interface: Ext

The node we ultimately extend.

Specified by:

node in interface Ext

pred

public NodeOps pred()

Description copied from interface: Ext

The parent of this extension.

Specified by:

pred in interface Ext

init

public void init(Node node)

Description copied from interface: Ext

Initialize the extension object's pointer back to the node. This also initializes the back pointers for all extensions of the extension.

Specified by:

init in interface Ext

initPred

public void initPred(NodeOps pred)

Description copied from interface: Ext

Initialize the extension object's pointer back to the parent. This also initializes the back pointers for all extensions of the extension.

Specified by:

initPred in interface Ext

ext

public Ext ext()

Description copied from interface: Ext

An extension of this extension, or null.

Specified by:

ext in interface Ext

ext

public Ext ext(Ext ext)

Description copied from interface: Ext

Set the extension of this extension.

Specified by:

ext in interface Ext

copy

public Ext copy()

Specified by:

copy in interface Copy<Ext>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dump

public void dump(CodeWriter w)

Description copied from interface: Ext

Dump the AST node for debugging purposes.

Specified by:

dump in interface Ext

visitChildren

public Node visitChildren(NodeVisitor v)

Description copied from interface: NodeOps

Visit the children of the node.

Specified by:

visitChildren in interface NodeOps

Parameters:

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

Returns:

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

enterScope

public Context enterScope(Context c)

Description copied from interface: NodeOps

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. This should not update the old context imperatively. Use addDecls when leaving the node for that.

Specified by:

enterScope in interface NodeOps

Parameters:

c - the current Context

Returns:

the Context to be used for visiting this node.

enterChildScope

public Context enterChildScope(Node child,
                      Context c)

Description copied from interface: NodeOps

Push a new scope for visiting the child node child. The default behavior is to delegate the call to the child node, and let it add appropriate declarations that should be in scope. However, this method gives parent nodes have the ability to modify this behavior.

Specified by:

enterChildScope in interface NodeOps

Parameters:

child - the child node about to be entered.

c - the current Context

Returns:

the Context to be used for visiting node child

addDecls

public void addDecls(Context c)

Description copied from interface: NodeOps

Add any declarations to the context that should be in scope when visiting later sibling nodes.

Specified by:

addDecls in interface NodeOps

Parameters:

c - The context to which to add declarations.

buildTypesEnter

public NodeVisitor buildTypesEnter(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 enter() method of the visitor. The * method should perform work that should be done before visiting the children of the node. The method may return this or a new copy of the node on which visitChildren() and leave() will be invoked.

Specified by:

buildTypesEnter in interface NodeOps

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

Parameters:

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

Throws:

SemanticException

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

ar - The visitor which disambiguates.

Throws:

SemanticException

disambiguateEnter

public NodeVisitor disambiguateEnter(AmbiguityRemover ar)
                              throws SemanticException

Description copied from interface: NodeOps

Remove any remaining ambiguities from the AST. This method is called by the enter() method of the visitor. The * method should perform work that should be done before visiting the children of the node. The method may return this or a new copy of the node on which visitChildren() and leave() will be invoked.

Specified by:

disambiguateEnter in interface NodeOps

Parameters:

ar - The visitor which disambiguates.

Throws:

SemanticException

disambiguate

public Node disambiguate(AmbiguityRemover ar)
                  throws SemanticException

Description copied from interface: NodeOps

Remove any remaining ambiguities from 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. The node should not assume that its children have been disambiguated. If it depends on a child being disambiguated, it may just return this without doing any work.

Specified by:

disambiguate in interface NodeOps

Parameters:

ar - The visitor which disambiguates.

Throws:

SemanticException

typeCheckOverride

public Node typeCheckOverride(Node parent,
                     TypeChecker tc)
                       throws SemanticException

Description copied from interface: NodeOps

Type check 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:

typeCheckOverride in interface NodeOps

tc - The type checking visitor.

Throws:

SemanticException

typeCheckEnter

public NodeVisitor typeCheckEnter(TypeChecker tc)
                           throws SemanticException

Description copied from interface: NodeOps

Type check the AST. This method is called by the enter() method of the visitor. The * method should perform work that should be done before visiting the children of the node. The method may return this or a new copy of the node on which visitChildren() and leave() will be invoked.

Specified by:

typeCheckEnter in interface NodeOps

Parameters:

tc - The type checking visitor.

Throws:

SemanticException

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

Parameters:

tc - The type checking visitor.

Throws:

SemanticException

childExpectedType

public Type childExpectedType(Expr child,
                     AscriptionVisitor av)

Description copied from interface: NodeOps

Get the expected type of a child expression of this. The expected type is determined by the context in that the child occurs (e.g., for x = e, the expected type of e is the declared type of x. The expected type should impose the least constraints on the child's type that are allowed by the parent node.

Specified by:

childExpectedType in interface NodeOps

Parameters:

child - A child expression of this node.

av - An ascription visitor.

Returns:

The expected type of child.

checkConstants

public Node checkConstants(ConstantChecker cc)
                    throws SemanticException

Description copied from interface: NodeOps

Check if the node is a compile-time constant. 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:

checkConstants in interface NodeOps

Parameters:

cc - The constant checking visitor.

Throws:

SemanticException

exceptionCheckEnter

public NodeVisitor exceptionCheckEnter(ExceptionChecker ec)
                                throws SemanticException

Description copied from interface: NodeOps

Check that exceptions are properly propagated throughout the AST. This method is called by the enter() method of the visitor. The * method should perform work that should be done before visiting the children of the node. The method may return this or a new copy of the node on which visitChildren() and leave() will be invoked.

Specified by:

exceptionCheckEnter in interface NodeOps

Parameters:

ec - The visitor.

Throws:

SemanticException

exceptionCheck

public Node exceptionCheck(ExceptionChecker ec)
                    throws SemanticException

Description copied from interface: NodeOps

Check that exceptions are properly propagated throughout 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:

exceptionCheck in interface NodeOps

Parameters:

ec - The visitor.

Throws:

SemanticException

throwTypes

public java.util.List<Type> throwTypes(TypeSystem ts)

Description copied from interface: NodeOps

List of Types of exceptions that might get thrown. The result is not necessarily correct until after type checking.

Specified by:

throwTypes in interface NodeOps

extRewriteEnter

public NodeVisitor extRewriteEnter(ExtensionRewriter rw)
                            throws SemanticException

Description copied from interface: NodeOps

Rewrite the AST for the compilation in this language. This method is called by the enter() method of the visitor. The method should perform work that should be done before visiting the children of the node. The method may return this or a new copy of the node on which visitChildren() and leave() will be invoked.

Specified by:

extRewriteEnter in interface NodeOps

Parameters:

rw - The 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

Parameters:

rw - The visitor.

Throws:

SemanticException

dump

@Deprecated
public void dump(java.io.OutputStream os)

Deprecated.

Description copied from interface: NodeOps

Dump the AST for debugging.

Specified by:

dump in interface NodeOps

dump

public void dump(Lang lang,
        java.io.OutputStream os)

Description copied from interface: NodeOps

Dump the AST for debugging.

Specified by:

dump in interface NodeOps

dump

@Deprecated
public void dump(java.io.Writer w)

Deprecated.

Description copied from interface: NodeOps

Dump the AST for debugging.

Specified by:

dump in interface NodeOps

dump

public void dump(Lang lang,
        java.io.Writer w)

Description copied from interface: NodeOps

Dump the AST for debugging.

Specified by:

dump in interface NodeOps

prettyPrint

@Deprecated
public void prettyPrint(java.io.OutputStream os)

Deprecated.

Description copied from interface: NodeOps

Pretty-print the AST for debugging.

Specified by:

prettyPrint in interface NodeOps

prettyPrint

public void prettyPrint(Lang lang,
               java.io.OutputStream os)

Description copied from interface: NodeOps

Pretty-print the AST for debugging.

Specified by:

prettyPrint in interface NodeOps

prettyPrint

@Deprecated
public void prettyPrint(java.io.Writer w)

Deprecated.

Description copied from interface: NodeOps

Pretty-print the AST for debugging.

Specified by:

prettyPrint in interface NodeOps

prettyPrint

public void prettyPrint(Lang lang,
               java.io.Writer w)

Description copied from interface: NodeOps

Pretty-print the AST for debugging.

Specified by:

prettyPrint in interface NodeOps

prettyPrint

public void prettyPrint(CodeWriter w,
               PrettyPrinter pp)

Description copied from interface: NodeOps

Pretty-print the AST using the given CodeWriter.

Specified by:

prettyPrint in interface NodeOps

Parameters:

w - The code writer to which to write.

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

print

public void print(Node child,
         CodeWriter w,
         PrettyPrinter pp)

printBlock

public void printBlock(Node n,
              CodeWriter w,
              PrettyPrinter pp)

printSubStmt

public void printSubStmt(Stmt stmt,
                CodeWriter w,
                PrettyPrinter pp)

translate

public void translate(CodeWriter w,
             Translator tr)

Description copied from interface: NodeOps

Translate the AST using the given CodeWriter.

Specified by:

translate in interface NodeOps

Parameters:

w - The code writer to which to write.

tr - The translation pass. This is not a visitor.

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

copy

public Node copy(ExtensionInfo extInfo)
          throws SemanticException

Description copied from interface: NodeOps

Produce a copy of this node using the given ExtensionInfo. This will typically be implemented by calling copy(NodeFactory nf), and then potentially copying over type information.

Specified by:

copy in interface NodeOps

Throws:

SemanticException - If the type information cannot be copied.