polyglot.ast

Class ProcedureDecl_c

java.lang.Object

polyglot.ast.Node_c

polyglot.ast.Term_c

polyglot.ast.ProcedureDecl_c

All Implemented Interfaces:

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

Direct Known Subclasses:

ConstructorDecl_c, MethodDecl_c

public abstract class ProcedureDecl_c
extends Term_c
implements ProcedureDecl, ProcedureDeclOps

A ProcedureDecl is an immutable representation of a constructor or method declaration as part of a class body.

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 Block	body
protected Flags	flags
protected java.util.List<Formal>	formals
protected Id	name
protected java.util.List<TypeNode>	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
ProcedureDecl_c(Position pos, Flags flags, Id name, java.util.List<Formal> formals, java.util.List<TypeNode> throwTypes, Block body) Deprecated.
ProcedureDecl_c(Position pos, Flags flags, 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
Block	body() The body of the method, constructor, or initializer.
CodeBlock	body(Block body) Set the body of the method, constructor, or initializer.
protected <N extends ProcedureDecl_c> N	body(N n, Block body)
NodeVisitor	buildTypesEnter(TypeBuilder tb) Collects classes, methods, and fields from the AST rooted at this node and constructs type objects for these.
Term	codeBody() The body of the method, constructor, initializer, or field initializer.
CodeInstance	codeInstance() The CodeInstance of the method, constructor, or initializer.
Node	disambiguate(AmbiguityRemover ar) Remove any remaining ambiguities from the AST.
void	dump(CodeWriter w) Dump the AST node for debugging purposes.
NodeVisitor	exceptionCheckEnter(ExceptionChecker ec) Check that exceptions are properly propagated throughout the AST.
Flags	flags() The procedure's flags.
ProcedureDecl	flags(Flags flags) Set the procedure's flags.
protected <N extends ProcedureDecl_c> N	flags(N n, Flags flags)
java.util.List<Formal>	formals() The procedure's formal parameters.
ProcedureDecl	formals(java.util.List<Formal> formals) Set the procedure's formal parameters.
protected <N extends ProcedureDecl_c> N	formals(N n, java.util.List<Formal> formals)
Id	id() The procedure's name.
ProcedureDecl	id(Id name) Set the procedure's name.
protected <N extends ProcedureDecl_c> N	id(N n, Id name)
java.lang.String	name() The procedure's name.
ProcedureDecl	name(java.lang.String name) Set the procedure's name.
void	prettyPrint(CodeWriter w, PrettyPrinter tr) Pretty-print the AST using the given CodeWriter.
abstract ProcedureInstance	procedureInstance() The procedure's type object.
protected <N extends ProcedureDecl_c> N	reconstruct(N n, Id name, java.util.List<Formal> formals, java.util.List<TypeNode> throwTypes, Block body) Reconstruct the procedure.
java.util.List<TypeNode>	throwTypes() The procedure's exception throw types.
ProcedureDecl	throwTypes(java.util.List<TypeNode> throwTypes) Set the procedure's exception throw types.
protected <N extends ProcedureDecl_c> N	throwTypes(N n, java.util.List<TypeNode> throwTypes)

Methods inherited from class polyglot.ast.Term_c

acceptCFG, exceptionCheck, exceptions, exceptions, exceptions, extRewrite, firstChild, listChild, reachable, reachable, reachable

Methods inherited from class polyglot.ast.Node_c

addDecls, buildTypes, checkConstants, childExpectedType, copy, copy, copy, copyIfNeeded, del, del, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, enterChildScope, enterScope, error, error, error, ext, ext, ext, ext, extRewriteEnter, isDisambiguated, isTypeChecked, lang, position, position, position, prettyPrint, prettyPrint, prettyPrint, prettyPrint, print, printBlock, printSubStmt, throwTypes, toString, translate, typeCheck, typeCheckEnter, typeCheckOverride, visit, visitChild, visitChildren, 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, error, error, ext, ext, ext, ext, isDisambiguated, isTypeChecked, position, position, visit, visitEdge

Methods inherited from interface polyglot.ast.NodeOps

addDecls, buildTypes, checkConstants, childExpectedType, copy, copy, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, enterChildScope, enterScope, exceptionCheck, extRewrite, extRewriteEnter, lang, prettyPrint, prettyPrint, prettyPrint, prettyPrint, throwTypes, translate, typeCheck, typeCheckEnter, typeCheckOverride, visitChild, visitChildren, visitList

Methods inherited from interface polyglot.util.Copy

copy

Methods inherited from interface polyglot.ast.ClassMember

memberInstance

Methods inherited from interface polyglot.ast.ProcedureDeclOps

prettyPrintHeader

Field Detail

flags

protected Flags flags

name

protected Id name

formals

protected java.util.List<Formal> formals

throwTypes

protected java.util.List<TypeNode> throwTypes

body

protected Block body

Constructor Detail

ProcedureDecl_c

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

Deprecated.

ProcedureDecl_c

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

Method Detail

flags

public Flags flags()

Description copied from interface: ProcedureDecl

The procedure's flags.

Specified by:

flags in interface ProcedureDecl

flags

public ProcedureDecl flags(Flags flags)

Description copied from interface: ProcedureDecl

Set the procedure's flags.

Specified by:

flags in interface ProcedureDecl

flags

protected <N extends ProcedureDecl_c> N flags(N n,
                                  Flags flags)

id

public Id id()

Description copied from interface: ProcedureDecl

The procedure's name.

Specified by:

id in interface ProcedureDecl

id

public ProcedureDecl id(Id name)

Description copied from interface: ProcedureDecl

Set the procedure's name.

Specified by:

id in interface ProcedureDecl

id

protected <N extends ProcedureDecl_c> N id(N n,
                               Id name)

name

public java.lang.String name()

Description copied from interface: ProcedureDecl

The procedure's name.

Specified by:

name in interface ProcedureDecl

name

public ProcedureDecl name(java.lang.String name)

Description copied from interface: ProcedureDecl

Set the procedure's name.

Specified by:

name in interface ProcedureDecl

formals

public java.util.List<Formal> formals()

Description copied from interface: ProcedureDecl

The procedure's formal parameters.

Specified by:

formals in interface ProcedureDecl

Returns:

A list of Formal.

formals

public ProcedureDecl formals(java.util.List<Formal> formals)

Description copied from interface: ProcedureDecl

Set the procedure's formal parameters.

Specified by:

formals in interface ProcedureDecl

Parameters:

formals - A list of Formal.

formals

protected <N extends ProcedureDecl_c> N formals(N n,
                                    java.util.List<Formal> formals)

throwTypes

public java.util.List<TypeNode> throwTypes()

Description copied from interface: ProcedureDecl

The procedure's exception throw types.

Specified by:

throwTypes in interface ProcedureDecl

Returns:

A list of TypeNode.

throwTypes

public ProcedureDecl throwTypes(java.util.List<TypeNode> throwTypes)

Description copied from interface: ProcedureDecl

Set the procedure's exception throw types.

Specified by:

throwTypes in interface ProcedureDecl

Parameters:

throwTypes - A list of TypeNode.

throwTypes

protected <N extends ProcedureDecl_c> N throwTypes(N n,
                                       java.util.List<TypeNode> throwTypes)

codeBody

public Term codeBody()

Description copied from interface: CodeNode

The body of the method, constructor, initializer, or field initializer.

Specified by:

codeBody in interface CodeNode

body

public Block body()

Description copied from interface: CodeBlock

The body of the method, constructor, or initializer.

Specified by:

body in interface CodeBlock

body

public CodeBlock body(Block body)

Description copied from interface: CodeBlock

Set the body of the method, constructor, or initializer.

Specified by:

body in interface CodeBlock

body

protected <N extends ProcedureDecl_c> N body(N n,
                                 Block body)

codeInstance

public CodeInstance codeInstance()

Description copied from interface: CodeNode

The CodeInstance of the method, constructor, or initializer.

Specified by:

codeInstance in interface CodeNode

procedureInstance

public abstract 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

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

Overrides:

buildTypesEnter in class Node_c

Parameters:

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

Throws:

SemanticException

reconstruct

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

Reconstruct the procedure.

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 Node_c

Parameters:

ar - The visitor which disambiguates.

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

Overrides:

exceptionCheckEnter in class Node_c

Parameters:

ec - The visitor.

Throws:

SemanticException

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.

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