cetus.hir

Class VariableDeclaration

java.lang.Object

cetus.hir.Declaration

cetus.hir.VariableDeclaration

All Implemented Interfaces:

Annotatable, Printable, Traversable, java.lang.Cloneable

public class VariableDeclaration
extends Declaration

Represents a statement that introduces a new variable or function prototype. A variable declaration is composed of specifiers and declarators. For example, in the declaration unsigned int x, y the specifiers would be unsigned and int while the declarators would be x and y.

Constructor Summary

Constructors

Constructor and Description
VariableDeclaration(Declarator declarator) Creates a variable declaration that does not use specifiers, such as for a constructor prototype.
VariableDeclaration(java.util.List specs) Creates a parameter declaration for a procedure, where the parameter is unnamed but its type is specified.
VariableDeclaration(java.util.List specs, Declarator declarator) Creates a variable declaration that has multiple specifiers, such as for unsigned int x.
VariableDeclaration(java.util.List specs, java.util.List declarator_list) Creates a declaration of multiple variables that has multiple specifiers, such as for unsigned int x, y, z.
VariableDeclaration(Specifier spec, Declarator declarator) Creates a variable declaration that has only one specifier, such as for int x.
VariableDeclaration(Specifier spec, java.util.List declarator_list) Creates a declaration of multiple variables that has only one specifier, such as for int x, y, z.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeclarator(Declarator declarator) Adds another declarator to this declaration.
VariableDeclaration	clone() Creates and returns a deep copy of this declaration.
static void	defaultPrint(VariableDeclaration d, java.io.PrintWriter o) Prints a declaration to a stream.
Declarator	getDeclarator(int n) Returns the nth declarator in this declaration.
java.util.List<IDExpression>	getDeclaredIDs() Returns a list of name ID introduced by this declaration.
java.util.List<Symbol>	getDeclaredSymbols() Returns the list of symbols being declared within this variable declaration.
int	getNumDeclarators() Returns the number of declarators in this declaration.
java.util.List<Specifier>	getSpecifiers()
boolean	isTypedef()
static void	setClassPrintMethod(java.lang.reflect.Method m) Overrides the class print method, so that all subsequently created objects will use the supplied method.

Methods inherited from class cetus.hir.Declaration

annotate, annotateAfter, annotateBefore, containsAnnotation, detach, equals, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getChildren, getParent, hashCode, print, removeAnnotations, removeAnnotations, removeChild, setChild, setParent, setPrintMethod, setSemiColon, toString, verify

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VariableDeclaration

public VariableDeclaration(Declarator declarator)

Creates a variable declaration that does not use specifiers, such as for a constructor prototype.

Parameters:

declarator - The only declarator in this declaration.

VariableDeclaration

public VariableDeclaration(java.util.List specs)

Creates a parameter declaration for a procedure, where the parameter is unnamed but its type is specified.

Parameters:

specs - A list of specifiers.

VariableDeclaration

public VariableDeclaration(Specifier spec,
                   Declarator declarator)

Creates a variable declaration that has only one specifier, such as for int x.

Parameters:

spec - A single specifier.

declarator - The only declarator in this declaration.

VariableDeclaration

public VariableDeclaration(java.util.List specs,
                   Declarator declarator)

Creates a variable declaration that has multiple specifiers, such as for unsigned int x.

Parameters:

specs - A list of specifiers.

declarator - The only declarator in this declaration.

VariableDeclaration

public VariableDeclaration(Specifier spec,
                   java.util.List declarator_list)

Creates a declaration of multiple variables that has only one specifier, such as for int x, y, z.

Parameters:

spec - A single specifier.

declarator_list - A list of declarators.

VariableDeclaration

public VariableDeclaration(java.util.List specs,
                   java.util.List declarator_list)

Creates a declaration of multiple variables that has multiple specifiers, such as for unsigned int x, y, z.

Parameters:

specs - A list of specifiers.

declarator_list - A list of declarators.

Method Detail

addDeclarator

public void addDeclarator(Declarator declarator)

Adds another declarator to this declaration. For example, if the declaration is int x; and a declarator for y is added, the declaration becomes int x, y;.

Parameters:

declarator - The declarator to add.

clone

public VariableDeclaration clone()

Description copied from class: Declaration

Creates and returns a deep copy of this declaration.

Overrides:

clone in class Declaration

Returns:

a deep copy of this declaration.

defaultPrint

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

Prints a declaration to a stream.

Parameters:

d - The declaration to print.

o - The stream on which to print the declaration.

getDeclarator

public Declarator getDeclarator(int n)

Returns the nth declarator in this declaration.

Parameters:

n - index of declarator to return

Returns:

the nth declarator in this declaration.

Throws:

java.lang.IndexOutOfBoundsException - if the nth declarator does not exist.

getDeclaredIDs

public java.util.List<IDExpression> getDeclaredIDs()

Description copied from class: Declaration

Returns a list of name ID introduced by this declaration.

Specified by:

getDeclaredIDs in class Declaration

Returns:

a list of IDExpressions. The list will not be null but may be empty.

getDeclaredSymbols

public java.util.List<Symbol> getDeclaredSymbols()

Returns the list of symbols being declared within this variable declaration. Basically, it is equivalent to using getChildren() but asserts the returned list contains symbol type.

Returns:

the list of declared symbols.

getNumDeclarators

public int getNumDeclarators()

Returns the number of declarators in this declaration.

Returns:

The number of declarators

getSpecifiers

public java.util.List<Specifier> getSpecifiers()

isTypedef

public boolean isTypedef()

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.