polyglot.ast

Class MethodDecl_c

java.lang.Object

polyglot.ast.Node_c

polyglot.ast.Term_c

polyglot.ast.ProcedureDecl_c

polyglot.ast.MethodDecl_c

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ClassMember, CodeBlock, CodeDecl, CodeNode, MethodDecl, Node, NodeOps, ProcedureDecl, ProcedureDeclOps, Term, TermOps, Copy<Node>

public class MethodDecl_c
extends ProcedureDecl_c
implements MethodDecl

A method declaration.

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 MethodInstance	mi
protected TypeNode	returnType

Fields inherited from class polyglot.ast.ProcedureDecl_c

body, flags, formals, name, throwTypes

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
MethodDecl_c(Position pos, Flags flags, TypeNode returnType, Id name, java.util.List<Formal> formals, java.util.List<TypeNode> throwTypes, Block body)
MethodDecl_c(Position pos, Flags flags, TypeNode returnType, Id name, java.util.List<Formal> formals, java.util.List<TypeNode> throwTypes, Block body, 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.
Node	buildTypes(TypeBuilder tb) Collects classes, methods, and fields from the AST rooted at this node and constructs type objects for these.
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.
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.
Term	firstChild() Return the first direct subterm performed when evaluating this term.
boolean	isDisambiguated()
MemberInstance	memberInstance()
MethodInstance	methodInstance() The method type object.
MethodDecl	methodInstance(MethodInstance mi) Set the method's type object.
protected <N extends MethodDecl_c> N	methodInstance(N n, MethodInstance mi)
void	overrideMethodCheck(TypeChecker tc)
void	prettyPrintHeader(Flags flags, CodeWriter w, PrettyPrinter tr) Pretty-print the procedure's header using the given code writer.
ProcedureInstance	procedureInstance() The procedure's type object.
protected <N extends MethodDecl_c> N	reconstruct(N n, TypeNode returnType, Id name, java.util.List<Formal> formals, java.util.List<TypeNode> throwTypes, Block body) Reconstruct the method.
TypeNode	returnType() The method's return type.
protected <N extends MethodDecl_c> N	returnType(N n, TypeNode returnType)
MethodDecl	returnType(TypeNode returnType) Set the method's return type.
void	throwsCheck(TypeChecker tc)
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.ProcedureDecl_c

body, body, body, buildTypesEnter, codeBody, codeInstance, exceptionCheckEnter, flags, flags, flags, formals, formals, formals, id, id, id, name, name, prettyPrint, reconstruct, throwTypes, throwTypes, throwTypes

Methods inherited from class polyglot.ast.Term_c

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

Methods inherited from class polyglot.ast.Node_c

addDecls, checkConstants, childExpectedType, copy, copy, copyIfNeeded, del, del, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, enterChildScope, error, error, error, 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.ProcedureDecl

flags, flags, formals, formals, id, id, name, name, throwTypes, throwTypes

Methods inherited from interface polyglot.ast.CodeBlock

body, body

Methods inherited from interface polyglot.ast.CodeNode

codeBody, codeInstance

Methods inherited from interface polyglot.ast.Term

exceptions, exceptions, reachable, reachable

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, buildTypesEnter, checkConstants, childExpectedType, copy, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, enterChildScope, exceptionCheck, exceptionCheckEnter, extRewriteEnter, lang, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrint, throwTypes, translate, typeCheckEnter, typeCheckOverride, visitChild, visitList

Methods inherited from interface polyglot.util.Copy

copy

Field Detail

returnType

protected TypeNode returnType

mi

protected MethodInstance mi

Constructor Detail

MethodDecl_c

public MethodDecl_c(Position pos,
            Flags flags,
            TypeNode returnType,
            Id name,
            java.util.List<Formal> formals,
            java.util.List<TypeNode> throwTypes,
            Block body)

MethodDecl_c

public MethodDecl_c(Position pos,
            Flags flags,
            TypeNode returnType,
            Id name,
            java.util.List<Formal> formals,
            java.util.List<TypeNode> throwTypes,
            Block body,
            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.

memberInstance

public MemberInstance memberInstance()

Specified by:

memberInstance in interface ClassMember

returnType

public TypeNode returnType()

Description copied from interface: MethodDecl

The method's return type.

Specified by:

returnType in interface MethodDecl

returnType

public MethodDecl returnType(TypeNode returnType)

Description copied from interface: MethodDecl

Set the method's return type.

Specified by:

returnType in interface MethodDecl

returnType

protected <N extends MethodDecl_c> N returnType(N n,
                                    TypeNode returnType)

procedureInstance

public ProcedureInstance procedureInstance()

Description copied from interface: ProcedureDecl

The procedure's type object. This field may not be valid until after signature disambiguation.

Specified by:

procedureInstance in interface ProcedureDecl

Specified by:

procedureInstance in class ProcedureDecl_c

methodInstance

public MethodInstance methodInstance()

Description copied from interface: MethodDecl

The method type object. This field may not be valid until after signature disambiguation.

Specified by:

methodInstance in interface MethodDecl

methodInstance

public MethodDecl methodInstance(MethodInstance mi)

Description copied from interface: MethodDecl

Set the method's type object.

Specified by:

methodInstance in interface MethodDecl

methodInstance

protected <N extends MethodDecl_c> N methodInstance(N n,
                                        MethodInstance mi)

reconstruct

protected <N extends MethodDecl_c> N reconstruct(N n,
                                     TypeNode returnType,
                                     Id name,
                                     java.util.List<Formal> formals,
                                     java.util.List<TypeNode> throwTypes,
                                     Block body)

Reconstruct the method.

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.

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

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

Overrides:

disambiguate in class ProcedureDecl_c

Parameters:

ar - The visitor which disambiguates.

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

throwsCheck

public void throwsCheck(TypeChecker tc)
                 throws SemanticException

Throws:

SemanticException

overrideMethodCheck

public void overrideMethodCheck(TypeChecker tc)
                         throws SemanticException

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 Term_c

Parameters:

rw - The visitor.

Throws:

SemanticException

toString

public java.lang.String toString()

Overrides:

toString in class Node_c

prettyPrintHeader

public void prettyPrintHeader(Flags flags,
                     CodeWriter w,
                     PrettyPrinter tr)

Description copied from interface: ProcedureDeclOps

Pretty-print the procedure's header using the given code writer.

Specified by:

prettyPrintHeader in interface ProcedureDeclOps

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 ProcedureDecl_c

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