polyglot.ast

Class Return_c

java.lang.Object

polyglot.ast.Node_c

polyglot.ast.Term_c

polyglot.ast.Stmt_c

polyglot.ast.Return_c

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Node, NodeOps, Return, Stmt, Term, TermOps, Copy<Node>

public class Return_c
extends Stmt_c
implements Return

A Return represents a return statement in Java. It may or may not return a value. If not expr() should return null.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface polyglot.ast.Term

Term.Instance

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

Copy.Util

Field Summary

Fields

Modifier and Type	Field and Description
protected Expr	expr

Fields inherited from class polyglot.ast.Term_c

exceptions, reachable

Fields inherited from class polyglot.ast.Node_c

del, error, ext, position

Fields inherited from interface polyglot.ast.Term

ENTRY, EXIT

Constructor Summary

Constructors

Constructor and Description
Return_c(Position pos, Expr expr)
Return_c(Position pos, Expr expr, Ext ext)

Method Summary

Methods

Modifier and Type	Method and Description
<T> java.util.List<T>	acceptCFG(CFGBuilder<?> v, java.util.List<T> succs) Visit this term in evaluation order, calling v.edge() for each successor in succs, if data flows on that edge.
Type	childExpectedType(Expr child, AscriptionVisitor av) Get the expected type of a child expression of this.
Node	copy(NodeFactory nf) Produce a copy of this node using the given NodeFactory.
Expr	expr() The expression to return, or null.
Return	expr(Expr expr) Set the expression to return.
protected <N extends Return_c> N	expr(N n, Expr expr)
Term	firstChild() Return the first direct subterm performed when evaluating this term.
void	prettyPrint(CodeWriter w, PrettyPrinter tr) Pretty-print the AST using the given CodeWriter.
protected <N extends Return_c> N	reconstruct(N n, Expr expr) Reconstruct the statement.
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.Term_c

exceptionCheck, exceptions, exceptions, exceptions, extRewrite, listChild, reachable, reachable, reachable

Methods inherited from class polyglot.ast.Node_c

addDecls, buildTypes, buildTypesEnter, checkConstants, copy, copy, copyIfNeeded, del, del, disambiguate, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, dump, enterChildScope, enterScope, error, error, error, exceptionCheckEnter, ext, ext, ext, ext, extRewriteEnter, isDisambiguated, 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.Term

exceptions, exceptions, reachable, reachable

Methods inherited from interface polyglot.ast.Node

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

Methods inherited from interface polyglot.ast.NodeOps

addDecls, buildTypes, buildTypesEnter, checkConstants, copy, disambiguate, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, enterChildScope, enterScope, exceptionCheck, exceptionCheckEnter, extRewrite, extRewriteEnter, lang, prettyPrint, prettyPrint, prettyPrint, prettyPrint, throwTypes, translate, typeCheckEnter, typeCheckOverride, visitChild, visitList

Methods inherited from interface polyglot.util.Copy

copy

Field Detail

expr

protected Expr expr

Constructor Detail

Return_c

public Return_c(Position pos,
        Expr expr)

Return_c

public Return_c(Position pos,
        Expr expr,
        Ext ext)

Method Detail

expr

public Expr expr()

Description copied from interface: Return

The expression to return, or null.

Specified by:

expr in interface Return

expr

public Return expr(Expr expr)

Description copied from interface: Return

Set the expression to return.

Specified by:

expr in interface Return

expr

protected <N extends Return_c> N expr(N n,
                          Expr expr)

reconstruct

protected <N extends Return_c> N reconstruct(N n,
                                 Expr expr)

Reconstruct the statement.

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.

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

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

Overrides:

childExpectedType in class Node_c

Parameters:

child - A child expression of this node.

av - An ascription visitor.

Returns:

The expected type of child.

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.

firstChild

public Term firstChild()

Description copied from interface: TermOps

Return the first direct subterm performed when evaluating this term. If this term has no subterms, this should return null. This method is similar to the deprecated entry(), but it should *not* recursively drill down to the innermost subterm. The direct child visited first in this term's dataflow should be returned.

Specified by:

firstChild in interface TermOps

Specified by:

firstChild in class Term_c

acceptCFG

public <T> java.util.List<T> acceptCFG(CFGBuilder<?> v,
                              java.util.List<T> succs)

Description copied from interface: TermOps

Visit this term in evaluation order, calling v.edge() for each successor in succs, if data flows on that edge.

Specified by:

acceptCFG in interface TermOps

Specified by:

acceptCFG in class Term_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