polyglot.ast

Class ClassDecl_c

java.lang.Object

polyglot.ast.Node_c

polyglot.ast.Term_c

polyglot.ast.ClassDecl_c

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ClassDecl, ClassDeclOps, ClassMember, Node, NodeOps, Term, TermOps, TopLevelDecl, Copy<Node>

public class ClassDecl_c
extends Term_c
implements ClassDecl, ClassDeclOps

A ClassDecl is the definition of a class, abstract class, or interface. It may be a public or other top-level class, or an inner named class, or an anonymous class.

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 ClassBody	body
protected ConstructorInstance	defaultCI
protected Flags	flags
protected boolean	implicitMembersAdded
protected java.util.List<TypeNode>	interfaces
protected Id	name
protected TypeNode	superClass
protected ParsedClassType	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
ClassDecl_c(Position pos, Flags flags, Id name, TypeNode superClass, java.util.List<TypeNode> interfaces, ClassBody body)
ClassDecl_c(Position pos, Flags flags, Id name, TypeNode superClass, java.util.List<TypeNode> interfaces, ClassBody 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	addDefaultConstructor(TypeSystem ts, NodeFactory nf, ConstructorInstance defaultCI)
protected Node	addDefaultConstructorIfNeeded(TypeSystem ts, NodeFactory nf)
ClassBody	body() The class's body.
ClassDecl	body(ClassBody body) Set the class's body.
protected <N extends ClassDecl_c> N	body(N n, ClassBody body)
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.
protected void	checkSupertypeCycles(TypeSystem ts)
Node	copy(NodeFactory nf) Produce a copy of this node using the given NodeFactory.
protected boolean	defaultConstructorNeeded()
Node	disambiguate(AmbiguityRemover ar) Remove any remaining ambiguities from the AST.
Node	disambiguateOverride(Node parent, AmbiguityRemover ar) Disambiguate the AST.
protected ClassDecl_c	disambiguateSupertypes(AmbiguityRemover ar)
void	dump(CodeWriter w) Dump the AST node for debugging purposes.
Context	enterChildScope(Node child, Context c) Push a new scope for visiting the child node child.
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() The class declaration's flags.
ClassDecl	flags(Flags flags) Set the class declaration's flags.
protected <N extends ClassDecl_c> N	flags(N n, Flags flags)
Id	id() The class declaration's name.
ClassDecl	id(Id name) Set the class declaration's name.
protected <N extends ClassDecl_c> N	id(N n, Id name)
java.util.List<TypeNode>	interfaces() The class's interface list.
ClassDecl	interfaces(java.util.List<TypeNode> interfaces) Set the class's interface list.
protected <N extends ClassDecl_c> N	interfaces(N n, java.util.List<TypeNode> interfaces)
boolean	isDisambiguated()
MemberInstance	memberInstance()
java.lang.String	name() The class declaration's name.
ClassDecl	name(java.lang.String name) Set the class declaration's name.
void	prettyPrint(CodeWriter w, PrettyPrinter tr) Pretty-print the AST using the given CodeWriter.
void	prettyPrintFooter(CodeWriter w, PrettyPrinter tr)
void	prettyPrintHeader(CodeWriter w, PrettyPrinter tr)
protected <N extends ClassDecl_c> N	reconstruct(N n, Id name, TypeNode superClass, java.util.List<TypeNode> interfaces, ClassBody body)
protected void	setInterfaces(AmbiguityRemover ar, java.util.List<TypeNode> newInterfaces)
protected void	setSuperClass(AmbiguityRemover ar, TypeNode superClass)
TypeNode	superClass() The class's super class.
protected <N extends ClassDecl_c> N	superClass(N n, TypeNode superClass)
ClassDecl	superClass(TypeNode superClass) Set the class's super class.
java.lang.String	toString()
ParsedClassType	type() The type of the class declaration.
protected <N extends ClassDecl_c> N	type(N n, ParsedClassType type)
ClassDecl	type(ParsedClassType type) Set the type of the class declaration.
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

addDecls, checkConstants, childExpectedType, copy, copy, copyIfNeeded, del, del, disambiguateEnter, dump, dump, dump, dump, 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

addDecls, checkConstants, childExpectedType, copy, disambiguateEnter, dump, dump, dump, dump, 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

flags

protected Flags flags

name

protected Id name

superClass

protected TypeNode superClass

interfaces

protected java.util.List<TypeNode> interfaces

body

protected ClassBody body

defaultCI

protected ConstructorInstance defaultCI

implicitMembersAdded

protected boolean implicitMembersAdded

type

protected ParsedClassType type

Constructor Detail

ClassDecl_c

public ClassDecl_c(Position pos,
           Flags flags,
           Id name,
           TypeNode superClass,
           java.util.List<TypeNode> interfaces,
           ClassBody body)

ClassDecl_c

public ClassDecl_c(Position pos,
           Flags flags,
           Id name,
           TypeNode superClass,
           java.util.List<TypeNode> interfaces,
           ClassBody 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

type

public ParsedClassType type()

Description copied from interface: ClassDecl

The type of the class declaration.

Specified by:

type in interface ClassDecl

type

public ClassDecl type(ParsedClassType type)

Description copied from interface: ClassDecl

Set the type of the class declaration.

Specified by:

type in interface ClassDecl

type

protected <N extends ClassDecl_c> N type(N n,
                             ParsedClassType type)

flags

public Flags flags()

Description copied from interface: ClassDecl

The class declaration's flags.

Specified by:

flags in interface ClassDecl

Specified by:

flags in interface TopLevelDecl

flags

public ClassDecl flags(Flags flags)

Description copied from interface: ClassDecl

Set the class declaration's flags.

Specified by:

flags in interface ClassDecl

flags

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

id

public Id id()

Description copied from interface: ClassDecl

The class declaration's name.

Specified by:

id in interface ClassDecl

id

public ClassDecl id(Id name)

Description copied from interface: ClassDecl

Set the class declaration's name.

Specified by:

id in interface ClassDecl

id

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

name

public java.lang.String name()

Description copied from interface: ClassDecl

The class declaration's name.

Specified by:

name in interface ClassDecl

Specified by:

name in interface TopLevelDecl

name

public ClassDecl name(java.lang.String name)

Description copied from interface: ClassDecl

Set the class declaration's name.

Specified by:

name in interface ClassDecl

superClass

public TypeNode superClass()

Description copied from interface: ClassDecl

The class's super class.

Specified by:

superClass in interface ClassDecl

superClass

public ClassDecl superClass(TypeNode superClass)

Description copied from interface: ClassDecl

Set the class's super class.

Specified by:

superClass in interface ClassDecl

superClass

protected <N extends ClassDecl_c> N superClass(N n,
                                   TypeNode superClass)

interfaces

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

Description copied from interface: ClassDecl

The class's interface list.

Specified by:

interfaces in interface ClassDecl

Returns:

A list of TypeNode.

interfaces

public ClassDecl interfaces(java.util.List<TypeNode> interfaces)

Description copied from interface: ClassDecl

Set the class's interface list.

Specified by:

interfaces in interface ClassDecl

Parameters:

interfaces - A list of TypeNode.

interfaces

protected <N extends ClassDecl_c> N interfaces(N n,
                                   java.util.List<TypeNode> interfaces)

body

public ClassBody body()

Description copied from interface: ClassDecl

The class's body.

Specified by:

body in interface ClassDecl

body

public ClassDecl body(ClassBody body)

Description copied from interface: ClassDecl

Set the class's body.

Specified by:

body in interface ClassDecl

body

protected <N extends ClassDecl_c> N body(N n,
                             ClassBody body)

reconstruct

protected <N extends ClassDecl_c> N reconstruct(N n,
                                    Id name,
                                    TypeNode superClass,
                                    java.util.List<TypeNode> interfaces,
                                    ClassBody body)

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.

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

enterChildScope

public Context enterChildScope(Node child,
                      Context c)

Description copied from interface: NodeOps

Push a new scope for visiting the child node child. The default behavior is to delegate the call to the child node, and let it add appropriate declarations that should be in scope. However, this method gives parent nodes have the ability to modify this behavior.

Specified by:

enterChildScope in interface NodeOps

Overrides:

enterChildScope in class Node_c

Parameters:

child - the child node about to be entered.

c - the current Context

Returns:

the Context to be used for visiting node child

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

disambiguateSupertypes

protected ClassDecl_c disambiguateSupertypes(AmbiguityRemover ar)
                                      throws SemanticException

Throws:

SemanticException

checkSupertypeCycles

protected void checkSupertypeCycles(TypeSystem ts)
                             throws SemanticException

Throws:

SemanticException

setSuperClass

protected void setSuperClass(AmbiguityRemover ar,
                 TypeNode superClass)
                      throws SemanticException

Throws:

SemanticException

setInterfaces

protected void setInterfaces(AmbiguityRemover ar,
                 java.util.List<TypeNode> newInterfaces)
                      throws SemanticException

Throws:

SemanticException

addDefaultConstructorIfNeeded

protected Node addDefaultConstructorIfNeeded(TypeSystem ts,
                                 NodeFactory nf)
                                      throws SemanticException

Throws:

SemanticException

defaultConstructorNeeded

protected boolean defaultConstructorNeeded()

addDefaultConstructor

public Node addDefaultConstructor(TypeSystem ts,
                         NodeFactory nf,
                         ConstructorInstance defaultCI)
                           throws SemanticException

Specified by:

addDefaultConstructor in interface ClassDeclOps

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

toString

public java.lang.String toString()

Overrides:

toString in class Node_c

prettyPrintHeader

public void prettyPrintHeader(CodeWriter w,
                     PrettyPrinter tr)

Specified by:

prettyPrintHeader in interface ClassDeclOps

prettyPrintFooter

public void prettyPrintFooter(CodeWriter w,
                     PrettyPrinter tr)

Specified by:

prettyPrintFooter in interface ClassDeclOps

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

disambiguateOverride

public Node disambiguateOverride(Node parent,
                        AmbiguityRemover ar)
                          throws SemanticException

Description copied from interface: NodeOps

Disambiguate the AST. This method is called by the override() method of the visitor. If this method returns non-null, the node's children will not be visited automatically. Thus, the method should check both the node this and it's children, usually by invoking visitChildren with tc or with another visitor, returning a non-null node. OR, the method should do nothing and simply return null to allow enter, visitChildren, and leave to be invoked on the node. The default implementation returns null. Overriding of this method is discouraged, but sometimes necessary.

Specified by:

disambiguateOverride in interface NodeOps

Overrides:

disambiguateOverride in class Node_c

ar - The visitor which disambiguates.

Throws:

SemanticException

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