cetus.hir

Class Identifier

java.lang.Object

cetus.hir.Expression

cetus.hir.IDExpression

cetus.hir.Identifier

All Implemented Interfaces:

Printable, Traversable, java.lang.Cloneable, java.lang.Comparable<Expression>

public class Identifier
extends IDExpression

Identifier represents a valid C identifier which has a matching variable declarator. It is important to notice that construction of a new Identifier object with an arbitrary string is not recommended at all because of possible inconsistency. For this reason such constructors are protected. For pass writers accustomed to such usage may still be able to create a string identifier through SymbolTools.getOrphanID(String). However, the correctness of any analysis/transformation after introducing such "orphan" identifier is not guaranteed.

Constructor Summary

Constructors

Constructor and Description
Identifier(Symbol symbol) Constructs and returns a new Identifier with the given Symbol object.

Method Summary

Methods

Modifier and Type	Method and Description
Identifier	clone() Returns a clone of this identifier.
static void	defaultPrint(Identifier i, java.io.PrintWriter o) Prints an identifier to a stream.
boolean	equals(java.lang.Object o) Checks if the given object o is equal to this identifier.
java.lang.String	getName() Returns the string name of this identifier.
Symbol	getSymbol() Returns the Symbol object linked with this identifier.
int	hashCode() Returns the hashcode of this identifier
java.lang.String	toString() Returns a string representation of this identifier (= getName()).

Methods inherited from class cetus.hir.IDExpression

findDeclaration, setGlobal, setTypename

Methods inherited from class cetus.hir.Expression

compareTo, findExpression, getChildren, getParent, getStatement, needsParens, print, printSelf, removeChild, setChild, setParens, setParent, setPrintMethod, swapWith, verify

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Identifier

public Identifier(Symbol symbol)

Constructs and returns a new Identifier with the given Symbol object.

Parameters:

symbol - the relevant symbol object, which is typically a varaible declarator.

Method Detail

clone

public Identifier clone()

Returns a clone of this identifier. For best consistency, the cloned identifier should be used in a scope in which the original symbol is accessible since the reference to the relevant symbol is also copied.

Overrides:

clone in class IDExpression

Returns:

a deep copy of this expression.

defaultPrint

public static void defaultPrint(Identifier i,
                java.io.PrintWriter o)

Prints an identifier to a stream.

Parameters:

i - The identifier to print.

o - The writer on which to print the identifier.

toString

public java.lang.String toString()

Returns a string representation of this identifier (= getName()).

Overrides:

toString in class Expression

equals

public boolean equals(java.lang.Object o)

Checks if the given object o is equal to this identifier.

Overrides:

equals in class Expression

Parameters:

o - the object to be compared with.

Returns:

true if the given object is an IDExpression and string comparison matches.

hashCode

public int hashCode()

Returns the hashcode of this identifier

Overrides:

hashCode in class Expression

Returns:

the integer hash code of the expression.

getName

public java.lang.String getName()

Returns the string name of this identifier.

Overrides:

getName in class IDExpression

Returns:

the string name of the relevant symbol object, or locally stored fall-back name if intended.

getSymbol

public Symbol getSymbol()

Returns the Symbol object linked with this identifier.