polyglot.ast

Class Formal_c

java.lang.Object

polyglot.ast.Node_c

polyglot.ast.Term_c

polyglot.ast.Formal_c

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Formal, Node, NodeOps, Term, TermOps, VarDecl, Copy<Node>

public class Formal_c
extends Term_c
implements Formal

A Formal represents a formal parameter for a procedure or catch block. It consists of a type and a variable identifier.

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 Flags	flags
protected LocalInstance	li
protected Id	name
protected TypeNode	type

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
Formal_c(Position pos, Flags flags, TypeNode type, Id name)
Formal_c(Position pos, Flags flags, TypeNode type, Id name, 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.
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.
Node	copy(NodeFactory nf) Produce a copy of this node using the given NodeFactory.
Type	declType() Get the type object for the declaration's type.
Node	disambiguate(AmbiguityRemover ar) Remove any remaining ambiguities from the AST.
void	dump(CodeWriter w) Dump the AST node for debugging purposes.
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.
Flags	flags() Get the flags of the formal.
Formal	flags(Flags flags) Set the flags of the formal.
protected <N extends Formal_c> N	flags(N n, Flags flags)
Id	id() Get the name of the formal.
Formal	id(Id name) Set the name of the formal.
protected <N extends Formal_c> N	id(N n, Id name)
boolean	isDisambiguated()
LocalInstance	localInstance() Get the local instance of the formal.
Formal	localInstance(LocalInstance li) Set the local instance of the formal.
protected <N extends Formal_c> N	localInstance(N n, LocalInstance li)
java.lang.String	name() Get the name of the formal.
Formal	name(java.lang.String name) Set the name of the formal.
void	prettyPrint(CodeWriter w, PrettyPrinter tr) Pretty-print the AST using the given CodeWriter.
protected <N extends Formal_c> N	reconstruct(N n, TypeNode type, Id name) Reconstruct the formal.
java.lang.String	toString()
TypeNode	type() Get the type node of the formal.
protected <N extends Formal_c> N	type(N n, TypeNode type)
Formal	type(TypeNode type) Set the type node of the formal.
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, listChild, reachable, reachable, reachable

Methods inherited from class polyglot.ast.Node_c

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

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

Methods inherited from interface polyglot.util.Copy

copy

Field Detail

li

protected LocalInstance li

flags

protected Flags flags

type

protected TypeNode type

name

protected Id name

Constructor Detail

Formal_c

public Formal_c(Position pos,
        Flags flags,
        TypeNode type,
        Id name)

Formal_c

public Formal_c(Position pos,
        Flags flags,
        TypeNode type,
        Id name,
        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.

declType

public Type declType()

Description copied from interface: VarDecl

Get the type object for the declaration's type.

Specified by:

declType in interface VarDecl

flags

public Flags flags()

Description copied from interface: Formal

Get the flags of the formal.

Specified by:

flags in interface Formal

Specified by:

flags in interface VarDecl

flags

public Formal flags(Flags flags)

Description copied from interface: Formal

Set the flags of the formal.

Specified by:

flags in interface Formal

flags

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

type

public TypeNode type()

Description copied from interface: Formal

Get the type node of the formal.

Specified by:

type in interface Formal

Specified by:

type in interface VarDecl

type

public Formal type(TypeNode type)

Description copied from interface: Formal

Set the type node of the formal.

Specified by:

type in interface Formal

type

protected <N extends Formal_c> N type(N n,
                          TypeNode type)

id

public Id id()

Description copied from interface: Formal

Get the name of the formal.

Specified by:

id in interface Formal

Specified by:

id in interface VarDecl

id

public Formal id(Id name)

Description copied from interface: Formal

Set the name of the formal.

Specified by:

id in interface Formal

id

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

name

public java.lang.String name()

Description copied from interface: Formal

Get the name of the formal.

Specified by:

name in interface Formal

Specified by:

name in interface VarDecl

name

public Formal name(java.lang.String name)

Description copied from interface: Formal

Set the name of the formal.

Specified by:

name in interface Formal

localInstance

public LocalInstance localInstance()

Description copied from interface: Formal

Get the local instance of the formal.

Specified by:

localInstance in interface Formal

Specified by:

localInstance in interface VarDecl

localInstance

public Formal localInstance(LocalInstance li)

Description copied from interface: Formal

Set the local instance of the formal.

Specified by:

localInstance in interface Formal

localInstance

protected <N extends Formal_c> N localInstance(N n,
                                   LocalInstance li)

reconstruct

protected <N extends Formal_c> N reconstruct(N n,
                                 TypeNode type,
                                 Id name)

Reconstruct the formal.

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.

addDecls

public void addDecls(Context c)

Description copied from class: Node_c

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

Specified by:

addDecls in interface NodeOps

Overrides:

addDecls in class Node_c

Parameters:

c - The context to which to add declarations.

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.

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

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

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

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

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

toString

public java.lang.String toString()

Overrides:

toString in class Node_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