polyglot.ast
Class FieldDecl_c

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

All Implemented Interfaces:

java.lang.Cloneable, ClassMember, CodeNode, FieldDecl, JL, Node, NodeOps, Term, VarInit, Copy

public class FieldDecl_c
extends Term_c
implements FieldDecl

A FieldDecl is an immutable representation of the declaration of a field of a class.

Nested Class Summary

static class

FieldDecl_c.AddDependenciesVisitor

Field Summary

protected FieldInstance	fi
protected Flags	flags
protected InitializerInstance	ii
protected Expr	init
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

Fields inherited from interface polyglot.ast.Term

ENTRY, EXIT

Constructor Summary

FieldDecl_c(Position pos, Flags flags, TypeNode type, Id name, Expr init)

Method Summary

java.util.List	acceptCFG(CFGBuilder v, java.util.List succs) Visit this term in evaluation order.
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.
Node	checkConstants(ConstantChecker cc) Check if the node is a compile-time constant.
Type	childExpectedType(Expr child, AscriptionVisitor av) Get the expected type of a child expression of this.
Term	codeBody() The body of the method, constructor, initializer, or field initializer.
CodeInstance	codeInstance() The CodeInstance of the method, constructor, or initializer.
boolean	constantValueSet() Whether the initializer has been determined to be constant or not.
Node	copy(NodeFactory nf) Produce a copy of this node using the given NodeFactory.
Type	declType() Get the type of the declaration.
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.
FieldInstance	fieldInstance() Get the field instance of the declaration.
FieldDecl	fieldInstance(FieldInstance fi) Set the field instance of the declaration.
Term	firstChild() Return the first direct subterm performed when evaluating this term.
Flags	flags() Get the flags of the declaration.
FieldDecl	flags(Flags flags) Set the flags of the declaration.
Id	id() Get the name of the declaration.
FieldDecl	id(Id name) Set the name of the declaration.
Expr	init() Get the initializer of the declaration.
FieldDecl	init(Expr init) Set the initializer of the declaration.
InitializerInstance	initializerInstance() Get the initializer instance of the initializer.
FieldDecl	initializerInstance(InitializerInstance ii) Set the initializer instance of the initializer.
boolean	isDisambiguated()
MemberInstance	memberInstance()
java.lang.String	name() Get the name of the declaration.
FieldDecl	name(java.lang.String name) Set the name of the declaration.
void	prettyPrint(CodeWriter w, PrettyPrinter tr) Pretty-print the AST using the given CodeWriter.
protected FieldDecl_c	reconstruct(TypeNode type, Id name, Expr init) Reconstruct the declaration.
java.lang.String	toString()
TypeNode	type() Get the type node of the declaration.
FieldDecl	type(TypeNode type) Set the type of the declaration.
Node	typeCheck(TypeChecker tc) Type check the declaration.
Node	typeCheckOverride(Node parent, TypeChecker tc) Type check the AST.
VarInstance	varInstance() The variable being initialized.
Node	visitChildren(NodeVisitor v) Visit the children of the declaration.

Methods inherited from class polyglot.ast.Term_c

exceptionCheck, exceptions, exceptions, listChild, reachable, reachable

Methods inherited from class polyglot.ast.Node_c

addDecls, 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, 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, visitChild, visitEdge, visitList

Methods inherited from interface polyglot.ast.JL

init, node

Methods inherited from interface polyglot.ast.NodeOps

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

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, visitChild, visitEdge, visitList

Methods inherited from interface polyglot.ast.JL

init, node

Methods inherited from interface polyglot.ast.NodeOps

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

Field Detail

flags

protected Flags flags

type

protected TypeNode type

name

protected Id name

init

protected Expr init

fi

protected FieldInstance fi

ii

protected InitializerInstance ii

Constructor Detail

FieldDecl_c

public FieldDecl_c(Position pos,
                   Flags flags,
                   TypeNode type,
                   Id name,
                   Expr init)

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

varInstance

public VarInstance varInstance()

Description copied from interface: VarInit

The variable being initialized.

Specified by:

varInstance in interface VarInit

codeInstance

public CodeInstance codeInstance()

Description copied from interface: CodeNode

The CodeInstance of the method, constructor, or initializer.

Specified by:

codeInstance in interface CodeNode

initializerInstance

public InitializerInstance initializerInstance()

Get the initializer instance of the initializer.

Specified by:

initializerInstance in interface FieldDecl

initializerInstance

public FieldDecl initializerInstance(InitializerInstance ii)

Set the initializer instance of the initializer.

Specified by:

initializerInstance in interface FieldDecl

declType

public Type declType()

Get the type of the declaration.

Specified by:

declType in interface FieldDecl

flags

public Flags flags()

Get the flags of the declaration.

Specified by:

flags in interface FieldDecl

flags

public FieldDecl flags(Flags flags)

Set the flags of the declaration.

Specified by:

flags in interface FieldDecl

type

public TypeNode type()

Get the type node of the declaration.

Specified by:

type in interface FieldDecl

type

public FieldDecl type(TypeNode type)

Set the type of the declaration.

Specified by:

type in interface FieldDecl

id

public Id id()

Get the name of the declaration.

Specified by:

id in interface FieldDecl

id

public FieldDecl id(Id name)

Set the name of the declaration.

Specified by:

id in interface FieldDecl

name

public java.lang.String name()

Get the name of the declaration.

Specified by:

name in interface FieldDecl

name

public FieldDecl name(java.lang.String name)

Set the name of the declaration.

Specified by:

name in interface FieldDecl

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

init

public Expr init()

Get the initializer of the declaration.

Specified by:

init in interface FieldDecl

init

public FieldDecl init(Expr init)

Set the initializer of the declaration.

Specified by:

init in interface FieldDecl

fieldInstance

public FieldDecl fieldInstance(FieldInstance fi)

Set the field instance of the declaration.

Specified by:

fieldInstance in interface FieldDecl

fieldInstance

public FieldInstance fieldInstance()

Get the field instance of the declaration.

Specified by:

fieldInstance in interface FieldDecl

reconstruct

protected FieldDecl_c reconstruct(TypeNode type,
                                  Id name,
                                  Expr init)

Reconstruct the declaration.

visitChildren

public Node visitChildren(NodeVisitor v)

Visit the children of the declaration.

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.

checkConstants

public Node checkConstants(ConstantChecker cc)
                    throws SemanticException

Description copied from interface: NodeOps

Check if the node is a compile-time constant. 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:

checkConstants in interface NodeOps

Overrides:

checkConstants in class Node_c

Parameters:

cc - The constant checking visitor.

Throws:

SemanticException

constantValueSet

public boolean constantValueSet()

Description copied from interface: VarInit

Whether the initializer has been determined to be constant or not.

Specified by:

constantValueSet in interface FieldDecl

Specified by:

constantValueSet in interface VarInit

typeCheckOverride

public Node typeCheckOverride(Node parent,
                              TypeChecker tc)
                       throws SemanticException

Description copied from class: Node_c

Type check the AST.

Specified by:

typeCheckOverride in interface NodeOps

Overrides:

typeCheckOverride in class Node_c

tc - The type checking visitor.

Throws:

SemanticException

typeCheck

public Node typeCheck(TypeChecker tc)
               throws SemanticException

Type check the declaration.

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

childExpectedType

public Type childExpectedType(Expr child,
                              AscriptionVisitor av)

Description copied from interface: Node

Get the expected type of a child expression of this. The expected type is determined by the context in that the child occurs (e.g., for x = e, the expected type of e is the declared type of x. The expected type should impose the least constraints on the child's type that are allowed by the parent node.

Specified by:

childExpectedType in interface Node

Overrides:

childExpectedType in class Node_c

Parameters:

child - A child expression of this node.

av - An ascription visitor.

Returns:

The expected type of child.

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

toString

public java.lang.String toString()

Overrides:

toString in class Node_c

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

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