polyglot.ast
Class ConstructorDecl_c

java.lang.Object
  polyglot.ast.Node_c
      polyglot.ast.Term_c
          polyglot.ast.ConstructorDecl_c

All Implemented Interfaces:

java.lang.Cloneable, ClassMember, CodeBlock, CodeDecl, CodeNode, ConstructorDecl, JL, Node, NodeOps, ProcedureDecl, Term, Copy

public class ConstructorDecl_c
extends Term_c
implements ConstructorDecl

A ConstructorDecl is an immutable representation of a constructor declaration as part of a class body.

Field Summary

protected Block	body
protected ConstructorInstance	ci
protected Flags	flags
protected java.util.List	formals
protected Id	name
protected java.util.List	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

ConstructorDecl_c(Position pos, Flags flags, Id name, java.util.List formals, java.util.List throwTypes, Block body)

Method Summary

java.util.List	acceptCFG(CFGBuilder v, java.util.List succs) Visit this term in evaluation order.
Block	body() Get the body of the constructor.
CodeBlock	body(Block body) Set the body of the constructor.
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.
Term	codeBody() The body of the method, constructor, initializer, or field initializer.
CodeInstance	codeInstance() The CodeInstance of the method, constructor, or initializer.
ConstructorInstance	constructorInstance() Get the constructorInstance of the constructor.
ConstructorDecl	constructorInstance(ConstructorInstance ci) Set the constructorInstance of the constructor.
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.
NodeVisitor	exceptionCheckEnter(ExceptionChecker ec) Check that exceptions are properly propagated throughout the AST.
Term	firstChild() Return the first direct subterm performed when evaluating this term.
Flags	flags() Get the flags of the constructor.
ConstructorDecl	flags(Flags flags) Set the flags of the constructor.
java.util.List	formals() Get the formals of the constructor.
ConstructorDecl	formals(java.util.List formals) Set the formals of the constructor.
Id	id() Get the name of the constructor.
ConstructorDecl	id(Id name) Set the name of the constructor.
boolean	isDisambiguated()
MemberInstance	memberInstance()
java.lang.String	name() Get the name of the constructor.
ConstructorDecl	name(java.lang.String name) Set the name of the constructor.
void	prettyPrint(CodeWriter w, PrettyPrinter tr) Pretty-print the AST using the given CodeWriter.
void	prettyPrintHeader(CodeWriter w, PrettyPrinter tr) Write the constructor to an output file.
ProcedureInstance	procedureInstance() Get the procedureInstance of the constructor.
protected ConstructorDecl_c	reconstruct(Id name, java.util.List formals, java.util.List throwTypes, Block body) Reconstruct the constructor.
java.util.List	throwTypes() Get the throwTypes of the constructor.
ConstructorDecl	throwTypes(java.util.List throwTypes) Set the throwTypes of the constructor.
java.lang.String	toString()
Node	typeCheck(TypeChecker tc) Type check the constructor.
Node	visitChildren(NodeVisitor v) Visit the children of the constructor.

Methods inherited from class polyglot.ast.Term_c

exceptionCheck, exceptions, exceptions, listChild, reachable, reachable

Methods inherited from class polyglot.ast.Node_c

addDecls, checkConstants, childExpectedType, copy, copy, del, del, disambiguateEnter, disambiguateOverride, dump, dump, enterChildScope, error, error, ext, ext, ext, ext, init, isTypeChecked, node, position, position, 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

childExpectedType, del, del, error, error, ext, ext, ext, ext, isTypeChecked, position, position, visit, visitChild, visitEdge, visitList

Methods inherited from interface polyglot.ast.JL

init, node

Methods inherited from interface polyglot.ast.NodeOps

addDecls, checkConstants, copy, disambiguateEnter, disambiguateOverride, dump, dump, enterChildScope, exceptionCheck, prettyPrint, prettyPrint, throwTypes, translate, typeCheckEnter, typeCheckOverride

Methods inherited from interface polyglot.util.Copy

copy

Field Detail

flags

protected Flags flags

name

protected Id name

formals

protected java.util.List formals

throwTypes

protected java.util.List throwTypes

body

protected Block body

ci

protected ConstructorInstance ci

Constructor Detail

ConstructorDecl_c

public ConstructorDecl_c(Position pos,
                         Flags flags,
                         Id name,
                         java.util.List formals,
                         java.util.List throwTypes,
                         Block body)

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

flags

public Flags flags()

Get the flags of the constructor.

Specified by:

flags in interface ConstructorDecl

Specified by:

flags in interface ProcedureDecl

flags

public ConstructorDecl flags(Flags flags)

Set the flags of the constructor.

Specified by:

flags in interface ConstructorDecl

id

public Id id()

Get the name of the constructor.

Specified by:

id in interface ConstructorDecl

id

public ConstructorDecl id(Id name)

Set the name of the constructor.

Specified by:

id in interface ConstructorDecl

name

public java.lang.String name()

Get the name of the constructor.

Specified by:

name in interface ConstructorDecl

Specified by:

name in interface ProcedureDecl

name

public ConstructorDecl name(java.lang.String name)

Set the name of the constructor.

Specified by:

name in interface ConstructorDecl

formals

public java.util.List formals()

Get the formals of the constructor.

Specified by:

formals in interface ConstructorDecl

Specified by:

formals in interface ProcedureDecl

Returns:

A list of Formal.

formals

public ConstructorDecl formals(java.util.List formals)

Set the formals of the constructor.

Specified by:

formals in interface ConstructorDecl

Parameters:

formals - A list of Formal.

throwTypes

public java.util.List throwTypes()

Get the throwTypes of the constructor.

Specified by:

throwTypes in interface ConstructorDecl

Specified by:

throwTypes in interface ProcedureDecl

Returns:

A list of TypeNode.

throwTypes

public ConstructorDecl throwTypes(java.util.List throwTypes)

Set the throwTypes of the constructor.

Specified by:

throwTypes in interface ConstructorDecl

Parameters:

throwTypes - A list of TypeNode.

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()

Get the body of the constructor.

Specified by:

body in interface CodeBlock

body

public CodeBlock body(Block body)

Set the body of the constructor.

Specified by:

body in interface CodeBlock

constructorInstance

public ConstructorInstance constructorInstance()

Get the constructorInstance of the constructor.

Specified by:

constructorInstance in interface ConstructorDecl

procedureInstance

public ProcedureInstance procedureInstance()

Get the procedureInstance of the constructor.

Specified by:

procedureInstance in interface ProcedureDecl

codeInstance

public CodeInstance codeInstance()

Description copied from interface: CodeNode

The CodeInstance of the method, constructor, or initializer.

Specified by:

codeInstance in interface CodeNode

constructorInstance

public ConstructorDecl constructorInstance(ConstructorInstance ci)

Set the constructorInstance of the constructor.

Specified by:

constructorInstance in interface ConstructorDecl

reconstruct

protected ConstructorDecl_c reconstruct(Id name,
                                        java.util.List formals,
                                        java.util.List throwTypes,
                                        Block body)

Reconstruct the constructor.

visitChildren

public Node visitChildren(NodeVisitor v)

Visit the children of the constructor.

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

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

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 Node_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

Type check the constructor.

Specified by:

typeCheck in interface NodeOps

Overrides:

typeCheck in class Node_c

Parameters:

tc - The type 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

Overrides:

exceptionCheckEnter in class Node_c

Parameters:

ec - The visitor.

Throws:

SemanticException

toString

public java.lang.String toString()

Overrides:

toString in class Node_c

prettyPrintHeader

public void prettyPrintHeader(CodeWriter w,
                              PrettyPrinter tr)

Write the constructor to an output file.

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

firstChild

public Term firstChild()

Description copied from interface: Term

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 Term

acceptCFG

public java.util.List acceptCFG(CFGBuilder v,
                                java.util.List succs)

Description copied from class: Term_c

Visit this term in evaluation order.

Specified by:

acceptCFG in interface Term

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