polyglot.ast

Class Field_c

java.lang.Object

polyglot.ast.Node_c

polyglot.ast.Term_c

polyglot.ast.Expr_c

polyglot.ast.Field_c

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Expr, ExprOps, Field, NamedVariable, Node, NodeOps, Prefix, Receiver, Term, TermOps, Typed, Variable, Copy<Node>

Direct Known Subclasses:

EnumConstant_c

public class Field_c
extends Expr_c
implements Field

A Field is an immutable representation of a Java field access. It consists of field name and may also have either a Type or an Expr containing the field being accessed.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface polyglot.util.Copy

Copy.Util

Nested classes/interfaces inherited from interface polyglot.ast.Term

Term.Instance

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldInstance	fi
protected Id	name
protected Receiver	target
protected boolean	targetImplicit

Fields inherited from class polyglot.ast.Expr_c

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
Field_c(Position pos, Receiver target, Id name)
Field_c(Position pos, Receiver target, 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.
Node	buildTypes(TypeBuilder tb) Collects classes, methods, and fields from the AST rooted at this node and constructs type objects for these.
protected void	checkConsistency(Context c) Check the consistency of the implicit target inserted by the compiler by asserting that the FieldInstance in the Context for this field's name is the same as the FieldInstance we assigned to this field.
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.
java.lang.Object	constantValue(Lang lang) Return the constant value of the expression, if any.
boolean	constantValueSet(Lang lang) Return true iff the compiler has determined whether this expression has a constant value.
Node	copy(NodeFactory nf) Produce a copy of this node using the given NodeFactory.
void	dump(CodeWriter w) Dump the AST node for debugging purposes.
Node	extRewrite(ExtensionRewriter rw) Rewrite the AST for the compilation in this language.
NodeVisitor	extRewriteEnter(ExtensionRewriter rw) Rewrite the AST for the compilation in this language.
FieldInstance	fieldInstance() Get the type object for the field.
Field	fieldInstance(FieldInstance fi) Set the type object for the field.
protected <N extends Field_c> N	fieldInstance(N n, FieldInstance fi)
Term	firstChild() Return the first direct subterm performed when evaluating this term.
Flags	flags() Return the access flags of the variable, or Flags.NONE
Id	id() Return the name of the variable.
Field	id(Id name) Set the field's name.
protected <N extends Field_c> N	id(N n, Id name)
boolean	isConstant(Lang lang) Return whether the expression evaluates to a constant.
boolean	isTargetImplicit() Returns whether the target of this field is implicit, that is if the target is either "this" or a classname, and the source code did not explicitly provide a target.
java.lang.String	name() Return the name of the variable.
Field	name(java.lang.String name) Set the field's name.
Precedence	precedence() Get the precedence of the expression.
void	prettyPrint(CodeWriter w, PrettyPrinter tr) Pretty-print the AST using the given CodeWriter.
protected <N extends Field_c> N	reconstruct(N n, Receiver target, Id name) Reconstruct the field.
Receiver	target() Get the field's container object or type.
protected <N extends Field_c> N	target(N n, Receiver target)
Field	target(Receiver target) Set the field's container object or type.
Field	targetImplicit(boolean targetImplicit) Set whether the target of the field is implicit.
protected <N extends Field_c> N	targetImplicit(N n, boolean targetImplicit)
java.util.List<Type>	throwTypes(TypeSystem ts) List of Types of exceptions that might get thrown.
java.lang.String	toString()
Node	typeCheck(TypeChecker tc) Type check the AST.
VarInstance	varInstance() Return the type object for the variable.
Node	visitChildren(NodeVisitor v) Visit the children of the node.

Methods inherited from class polyglot.ast.Expr_c

booleanValue, byteValue, charValue, constantValue, constantValueSet, doubleValue, floatValue, intValue, isConstant, isTypeChecked, lastLang, longValue, printSubExpr, printSubExpr, shortValue, stringValue, type, type, type

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, buildTypesEnter, copy, copy, copyIfNeeded, del, del, disambiguate, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, enterChildScope, enterScope, error, error, error, exceptionCheckEnter, ext, ext, ext, ext, isDisambiguated, lang, position, position, position, prettyPrint, prettyPrint, prettyPrint, prettyPrint, print, printBlock, printSubStmt, 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.Expr

constantValue, constantValueSet, isConstant, printSubExpr, printSubExpr, type

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, buildTypesEnter, copy, disambiguate, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, enterChildScope, enterScope, exceptionCheck, exceptionCheckEnter, lang, prettyPrint, prettyPrint, prettyPrint, prettyPrint, translate, typeCheckEnter, typeCheckOverride, visitChild, visitList

Methods inherited from interface polyglot.util.Copy

copy

Methods inherited from interface polyglot.ast.Typed

type

Methods inherited from interface polyglot.ast.Term

exceptions, exceptions, reachable, reachable

Field Detail

target

protected Receiver target

name

protected Id name

fi

protected FieldInstance fi

targetImplicit

protected boolean targetImplicit

Constructor Detail

Field_c

public Field_c(Position pos,
       Receiver target,
       Id name)

Field_c

public Field_c(Position pos,
       Receiver target,
       Id name,
       Ext ext)

Method Detail

precedence

public Precedence precedence()

Description copied from interface: Expr

Get the precedence of the expression.

Specified by:

precedence in interface Expr

Overrides:

precedence in class Expr_c

target

public Receiver target()

Description copied from interface: Field

Get the field's container object or type. May be null before disambiguation.

Specified by:

target in interface Field

target

public Field target(Receiver target)

Description copied from interface: Field

Set the field's container object or type.

Specified by:

target in interface Field

target

protected <N extends Field_c> N target(N n,
                           Receiver target)

id

public Id id()

Description copied from interface: NamedVariable

Return the name of the variable.

Specified by:

id in interface NamedVariable

id

public Field id(Id name)

Description copied from interface: Field

Set the field's name.

Specified by:

id in interface Field

id

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

name

public java.lang.String name()

Description copied from interface: NamedVariable

Return the name of the variable.

Specified by:

name in interface NamedVariable

name

public Field name(java.lang.String name)

Description copied from interface: Field

Set the field's name.

Specified by:

name in interface Field

flags

public Flags flags()

Description copied from interface: NamedVariable

Return the access flags of the variable, or Flags.NONE

Specified by:

flags in interface NamedVariable

Specified by:

flags in interface Variable

varInstance

public VarInstance varInstance()

Description copied from interface: NamedVariable

Return the type object for the variable.

Specified by:

varInstance in interface NamedVariable

fieldInstance

public FieldInstance fieldInstance()

Description copied from interface: Field

Get the type object for the field. This field may not be valid until after type checking.

Specified by:

fieldInstance in interface Field

fieldInstance

public Field fieldInstance(FieldInstance fi)

Description copied from interface: Field

Set the type object for the field.

Specified by:

fieldInstance in interface Field

fieldInstance

protected <N extends Field_c> N fieldInstance(N n,
                                  FieldInstance fi)

isTargetImplicit

public boolean isTargetImplicit()

Description copied from interface: Field

Returns whether the target of this field is implicit, that is if the target is either "this" or a classname, and the source code did not explicitly provide a target.

Specified by:

isTargetImplicit in interface Field

targetImplicit

public Field targetImplicit(boolean targetImplicit)

Description copied from interface: Field

Set whether the target of the field is implicit.

Specified by:

targetImplicit in interface Field

targetImplicit

protected <N extends Field_c> N targetImplicit(N n,
                                   boolean targetImplicit)

reconstruct

protected <N extends Field_c> N reconstruct(N n,
                                Receiver target,
                                Id name)

Reconstruct the field.

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.

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 Expr_c

Parameters:

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

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

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

childExpectedType

public Type childExpectedType(Expr child,
                     AscriptionVisitor av)

Description copied from interface: NodeOps

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 NodeOps

Overrides:

childExpectedType in class Node_c

Parameters:

child - A child expression of this node.

av - An ascription visitor.

Returns:

The expected type of child.

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 Expr_c

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

throwTypes

public java.util.List<Type> throwTypes(TypeSystem ts)

Description copied from interface: NodeOps

List of Types of exceptions that might get thrown. The result is not necessarily correct until after type checking.

Specified by:

throwTypes in interface NodeOps

Overrides:

throwTypes in class Node_c

extRewriteEnter

public NodeVisitor extRewriteEnter(ExtensionRewriter rw)
                            throws SemanticException

Description copied from interface: NodeOps

Rewrite the AST for the compilation in this language. 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:

extRewriteEnter in interface NodeOps

Overrides:

extRewriteEnter in class Node_c

Parameters:

rw - The 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 Expr_c

Parameters:

rw - The visitor.

Throws:

SemanticException

constantValueSet

public boolean constantValueSet(Lang lang)

Description copied from interface: ExprOps

Return true iff the compiler has determined whether this expression has a constant value. The value returned by isConstant() is valid only if constantValueSet() is true.

Specified by:

constantValueSet in interface ExprOps

Overrides:

constantValueSet in class Expr_c

isConstant

public boolean isConstant(Lang lang)

Description copied from interface: ExprOps

Return whether the expression evaluates to a constant. Requires that disambiguation has been done, and that constantValueSet() is true.

Specified by:

isConstant in interface ExprOps

Overrides:

isConstant in class Expr_c

constantValue

public java.lang.Object constantValue(Lang lang)

Description copied from interface: ExprOps

Return the constant value of the expression, if any. Requires that isConstant() is true.

Specified by:

constantValue in interface ExprOps

Overrides:

constantValue in class Expr_c

checkConsistency

protected void checkConsistency(Context c)

Check the consistency of the implicit target inserted by the compiler by asserting that the FieldInstance in the Context for this field's name is the same as the FieldInstance we assigned to this field.

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