cetus.hir

Class ProcedureDeclarator

java.lang.Object

cetus.hir.Declarator

cetus.hir.ProcedureDeclarator

All Implemented Interfaces:

Printable, Symbol, Traversable, java.lang.Cloneable

public class ProcedureDeclarator
extends Declarator
implements Symbol

Represents a declarator for a Procedure in a VariableDeclaration.

Constructor Summary

Constructors

Constructor and Description
ProcedureDeclarator(IDExpression direct_decl, java.util.List params) Constructs a new procedure declarator with the given ID and the list of parameters.
ProcedureDeclarator(IDExpression direct_decl, java.util.List params, java.util.List trailing_specs) Consturcts a new procedure declarator with the given ID, list of parameters, and the trailing specifiers.
ProcedureDeclarator(java.util.List leading_specs, IDExpression direct_decl, java.util.List params) Constructs a new procedure declarator with the given leading specifiers, the ID, and the list of parameters.
ProcedureDeclarator(java.util.List leading_specs, IDExpression direct_decl, java.util.List params, java.util.List trailing_specs, ExceptionSpecification espec) Constructs a new procedure declarator with the given leading specifiers, the ID, the trailing specifiers, and the exception specification.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(Declaration decl) Inserts a new parameter declaration at the end of the parameter list.
void	addParameterAfter(Declaration ref, Declaration decl) Inserts a new parameter declaration after the specified reference parameter declaration.
void	addParameterBefore(Declaration ref, Declaration decl) Inserts a new parameter declaration before the specified reference parameter declaration.
ProcedureDeclarator	clone() Returns a clone of the procedure declarator.
static void	defaultPrint(ProcedureDeclarator d, java.io.PrintWriter o) Prints a procedure declarator to a stream.
java.util.List	getArraySpecifiers() Returns the list of specifiers trailing the declarator.
Declaration	getDeclaration() Returns the parent declaration of the procedure declarator if one exists.
IDExpression	getID() Returns the name ID of the procedure declarator.
java.util.List<Declaration>	getParameters() Returns the list of parameter declaration of the procedure declarator.
java.lang.String	getSymbolName() Returns the name of the symbol.
java.util.List	getTypeSpecifiers() Returns a list of type specifiers.
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	setName(java.lang.String name) Modify the name of the symbol.

Methods inherited from class cetus.hir.Declarator

addTrailingSpecifier, defaultPrint, equals, getChildren, getInitializer, getParameter, getParent, getSpecifiers, hashCode, print, removeChild, setChild, setInitializer, setParent, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcedureDeclarator

public ProcedureDeclarator(IDExpression direct_decl,
                   java.util.List params)

Constructs a new procedure declarator with the given ID and the list of parameters.

Parameters:

direct_decl - the IDExpression used for this procedure name; it is highly recommended to use NameID since this constructor internally replaces the parameter with an equivalent NameID object.

params - the list of function parameters.

ProcedureDeclarator

public ProcedureDeclarator(IDExpression direct_decl,
                   java.util.List params,
                   java.util.List trailing_specs)

Consturcts a new procedure declarator with the given ID, list of parameters, and the trailing specifiers.

Parameters:

direct_decl - the IDExpression used for this procedure name; it is highly recommended to use NameID since this constructor internally replaces the parameter with an equivalent NameID object.

params - the list of function parameters.

trailing_specs - the list of trailing specifiers.

ProcedureDeclarator

public ProcedureDeclarator(java.util.List leading_specs,
                   IDExpression direct_decl,
                   java.util.List params)

Constructs a new procedure declarator with the given leading specifiers, the ID, and the list of parameters. This is the most commonly used constructor for C input language.

Parameters:

leading_specs - the list of leading specifiers.

direct_decl - the IDExpression used for this procedure name; it is highly recommended to use NameID since this constructor internally replaces the parameter with an equivalent NameID object.

params - the list of function parameters.

ProcedureDeclarator

public ProcedureDeclarator(java.util.List leading_specs,
                   IDExpression direct_decl,
                   java.util.List params,
                   java.util.List trailing_specs,
                   ExceptionSpecification espec)

Constructs a new procedure declarator with the given leading specifiers, the ID, the trailing specifiers, and the exception specification. This constructor is not used for C programs.

Parameters:

leading_specs - the list of leading specifiers.

direct_decl - the IDExpression used for this procedure name; it is highly recommended to use NameID since this constructor internally replaces the parameter with an equivalent NameID object.

params - the list of function parameters.

trailing_specs - the list of trailing specifiers.

espec - the exception specification.

Method Detail

addParameter

public void addParameter(Declaration decl)

Inserts a new parameter declaration at the end of the parameter list.

Specified by:

addParameter in class Declarator

Parameters:

decl - the new parameter declaration to be added.

addParameterBefore

public void addParameterBefore(Declaration ref,
                      Declaration decl)

Inserts a new parameter declaration before the specified reference parameter declaration.

Specified by:

addParameterBefore in class Declarator

Parameters:

ref - the reference parameter declaration.

decl - the new parameter declaration to be added.

addParameterAfter

public void addParameterAfter(Declaration ref,
                     Declaration decl)

Inserts a new parameter declaration after the specified reference parameter declaration.

Specified by:

addParameterAfter in class Declarator

Parameters:

ref - the reference parameter declaration.

decl - the new parameter declaration to be added.

clone

public ProcedureDeclarator clone()

Returns a clone of the procedure declarator.

Overrides:

clone in class Declarator

defaultPrint

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

Prints a procedure 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 the procedure declarator.

Specified by:

getID in class Declarator

Returns:

the name ID of the declarator.

getParameters

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

Returns the list of parameter declaration of the procedure declarator.

Specified by:

getParameters in class Declarator

Returns:

List null is returned when there is no Function Parameter in the 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.

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()

Returns the parent declaration of the procedure declarator if one exists. The procedure declarators that are not included in the IR tree (e.g., field of a procedure object) does not have any parent declaration since search is not posssible (hence null is returned), whereas a procedure declarator that appears as a child of a variable declaration has a specific parent declaration.

Specified by:

getDeclaration in interface Symbol

Returns:

the parent declaration if one exists, null otherwise.