cetus.hir

Class VariableDeclarator

java.lang.Object

cetus.hir.Declarator

cetus.hir.VariableDeclarator

All Implemented Interfaces:

Printable, Symbol, Traversable, java.lang.Cloneable

public class VariableDeclarator
extends Declarator
implements Symbol

Represents a declarator for a variable in a VariableDeclaration.

Constructor Summary

Constructors

Constructor and Description
VariableDeclarator(IDExpression direct_decl) Constructs a new VariableDeclarator with the given ID.
VariableDeclarator(IDExpression direct_decl, java.util.List trailing_specs) Constructs a new variable declarator with the given ID and the trailing specifiers.
VariableDeclarator(IDExpression direct_decl, Specifier spec) Constructs a new variable declarator with the given name ID and the trailing specifier.
VariableDeclarator(java.util.List leading_specs, IDExpression direct_decl) Constructs a new variable declarator with the given leading specifiers and the name ID.
VariableDeclarator(java.util.List leading_specs, IDExpression direct_decl, java.util.List trailing_specs) Constructs a new variable declarator with the given leading specifiers, the name ID, and the trailing specifiers.
VariableDeclarator(Specifier spec, IDExpression direct_decl) Constructs a new variable declarator with the given leading specifier and the name ID.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(Declaration decl) Inserts a new child declaration to the parameter list.
void	addParameterAfter(Declaration ref, Declaration decl) Inserts a new child declaration to the parameter list after the given reference declaration.
void	addParameterBefore(Declaration ref, Declaration decl) Inserts a new child declaration to the parameter list before the given reference declaration.
VariableDeclarator	clone() Returns a clone of this variable declarator.
static void	defaultPrint(VariableDeclarator d, java.io.PrintWriter o) Prints a variable declarator to a stream.
boolean	equals(java.lang.Object obj) Checks if the given Object obj refers to the same Symbol as this Symbol.
java.util.List	getArraySpecifiers() Returns the list of specifiers trailing the declarator.
Declaration	getDeclaration() Returns the parent declaration containing the symbol object.
IDExpression	getID() Returns the name ID of this variable declarator.
Initializer	getInitializer() Returns the initializer of this variable declarator.
java.util.List<Declaration>	getParameters() Returns a List of Function Parameter
java.util.List	getSpecifiers() Returns the list of leading specifiers of this variable declarator.
java.lang.String	getSymbolName() Returns the name of the symbol.
java.util.List	getTrailingSpecifiers() Returns the list of trailing specifiers of this variable declarator.
java.util.List	getTypeSpecifiers() Returns a list of type specifiers.
int	hashCode() If there are multiple Symbols with external linkage and same name, hashCode() returns same value for those symbols
static void	setClassPrintMethod(java.lang.reflect.Method m) Overrides the class print method, so that all subsequently created objects will use the supplied method.
void	setInitializer(Initializer init) Assigns a new initializer init for the variable declarator.
void	setName(java.lang.String name) Modify the name of the symbol.

Methods inherited from class cetus.hir.Declarator

addTrailingSpecifier, defaultPrint, getChildren, getParameter, getParent, print, removeChild, setChild, setParent, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VariableDeclarator

public VariableDeclarator(IDExpression direct_decl)

Constructs a new VariableDeclarator with the given ID. It is highly recommended to use a NameID object for direct_decl since the constructor internally assigns a new NameID if direct_decl is not an instanceof NameID.

Parameters:

direct_decl - the given name ID for the new variable declarator.

VariableDeclarator

public VariableDeclarator(IDExpression direct_decl,
                  java.util.List trailing_specs)

Constructs a new variable declarator with the given ID and the trailing specifiers. It is highly recommended to use a NameID object for direct_decl since the constructor internally assigns a new NameID if direct_decl is not an instanceof NameID.

Parameters:

direct_decl - the given name ID.

trailing_specs - the list of trailing specifiers.

VariableDeclarator

public VariableDeclarator(IDExpression direct_decl,
                  Specifier spec)

Constructs a new variable declarator with the given name ID and the trailing specifier. It is highly recommended to use a NameID object for direct_decl since the constructor internally assigns a new NameID if direct_decl is not an instanceof NameID.

Parameters:

direct_decl - the given name ID.

spec - the given trailing specifier.

VariableDeclarator

public VariableDeclarator(java.util.List leading_specs,
                  IDExpression direct_decl)

Constructs a new variable declarator with the given leading specifiers and the name ID. It is highly recommended to use a NameID object for direct_decl since the constructor internally assigns a new NameID if direct_decl is not an instanceof NameID.

Parameters:

leading_specs - the list of leading specifiers.

direct_decl - the given name ID.

VariableDeclarator

public VariableDeclarator(java.util.List leading_specs,
                  IDExpression direct_decl,
                  java.util.List trailing_specs)

Constructs a new variable declarator with the given leading specifiers, the name ID, and the trailing specifiers. It is highly recommended to use a NameID object for direct_decl since the constructor internally assigns a new NameID if direct_decl is not an instanceof NameID.

Parameters:

leading_specs - the list of leading specifiers.

direct_decl - the given name ID.

trailing_specs - the list of trailing specifiers.

VariableDeclarator

public VariableDeclarator(Specifier spec,
                  IDExpression direct_decl)

Constructs a new variable declarator with the given leading specifier and the name ID. It is highly recommended to use a NameID object for direct_decl since the constructor internally assigns a new NameID if direct_decl is not an instanceof NameID.

Parameters:

spec - the given leading specifier.

direct_decl - the given name ID.

Method Detail

clone

public VariableDeclarator clone()

Returns a clone of this variable declarator.

Overrides:

clone in class Declarator

defaultPrint

public static void defaultPrint(VariableDeclarator d,
                java.io.PrintWriter o)

Prints a variable declarator to a stream.

Parameters:

d - The declarator to print.

o - The writer on which to print the declarator.

getID

public IDExpression getID()

Returns the name ID of this variable declarator.

Specified by:

getID in class Declarator

Returns:

the name ID of the declarator.

getSpecifiers

public java.util.List getSpecifiers()

Returns the list of leading specifiers of this variable declarator.

Overrides:

getSpecifiers in class Declarator

Returns:

the leading specifiers.

getTrailingSpecifiers

public java.util.List getTrailingSpecifiers()

Returns the list of trailing specifiers of this variable declarator.

setClassPrintMethod

public static void setClassPrintMethod(java.lang.reflect.Method m)

Overrides the class print method, so that all subsequently created objects will use the supplied method.

Parameters:

m - The new print method.

getInitializer

public Initializer getInitializer()

Returns the initializer of this variable declarator.

Overrides:

getInitializer in class Declarator

Returns:

the initializer if it exists, null otherwise.

setInitializer

public void setInitializer(Initializer init)

Assigns a new initializer init for the variable declarator. The existing initializer is discarded if exists.

Overrides:

setInitializer in class Declarator

Parameters:

init - An initial value for the variable.

getSymbolName

public java.lang.String getSymbolName()

Description copied from interface: Symbol

Returns the name of the symbol.

Specified by:

getSymbolName in interface Symbol

Returns:

the name of the symbol.

getTypeSpecifiers

public java.util.List getTypeSpecifiers()

Description copied from interface: Symbol

Returns a list of type specifiers.

Specified by:

getTypeSpecifiers in interface Symbol

Returns:

the list of type specifiers.

getArraySpecifiers

public java.util.List getArraySpecifiers()

Description copied from class: Declarator

Returns the list of specifiers trailing the declarator.

Specified by:

getArraySpecifiers in interface Symbol

Overrides:

getArraySpecifiers in class Declarator

Returns:

the trailing specifiers.

setName

public void setName(java.lang.String name)

Description copied from interface: Symbol

Modify the name of the symbol. This method effectively renames all the identifiers constructed from the symbol object. Pass writers should be cautious when renaming global names since the effective scope of this operation is within a translation unit; extern variables and procedure names are not automatically handled.

Specified by:

setName in interface Symbol

Parameters:

name - the new name of the symbol.

getDeclaration

public Declaration getDeclaration()

Description copied from interface: Symbol

Returns the parent declaration containing the symbol object. The return value is searched from the internal look-up table. Depending on the type of the symbol, this method may return the symbol object itself, or null if the symbol object does not exist in the IR.

Specified by:

getDeclaration in interface Symbol

Returns:

the parent declaration.

getParameters

public java.util.List<Declaration> getParameters()

Description copied from class: Declarator

Returns a List of Function Parameter

Specified by:

getParameters in class Declarator

Returns:

List null is returned when there is no Function Parameter in the Declarator

addParameter

public void addParameter(Declaration decl)

Description copied from class: Declarator

Inserts a new child declaration to the parameter list.

Specified by:

addParameter in class Declarator

Parameters:

decl - the new parameter declaration to be inserted.

addParameterAfter

public void addParameterAfter(Declaration ref,
                     Declaration decl)

Description copied from class: Declarator

Inserts a new child declaration to the parameter list after the given reference declaration.

Specified by:

addParameterAfter in class Declarator

Parameters:

ref - the reference parameter declaration.

decl - the new parameter declaration to be inserted.

addParameterBefore

public void addParameterBefore(Declaration ref,
                      Declaration decl)

Description copied from class: Declarator

Inserts a new child declaration to the parameter list before the given reference declaration.

Specified by:

addParameterBefore in class Declarator

Parameters:

ref - the reference parameter declaration.

decl - the new parameter declaration to be inserted.

equals

public boolean equals(java.lang.Object obj)

Checks if the given Object obj refers to the same Symbol as this Symbol.

Overrides:

equals in class Declarator

Parameters:

obj -

Returns:

true if obj refers to the same memory location as this Symbol.

hashCode

public int hashCode()

If there are multiple Symbols with external linkage and same name, hashCode() returns same value for those symbols

Overrides:

hashCode in class Declarator

Returns:

the computed hash code.