scale.clef.decl
Class ProcedureDecl

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.decl.Declaration
              scale.clef.decl.RoutineDecl
                  scale.clef.decl.ProcedureDecl

All Implemented Interfaces:

java.lang.Comparable, AnnotationInterface, DisplayNode

Direct Known Subclasses:

ForwardProcedureDecl

public class ProcedureDecl
extends RoutineDecl

This class represents the declaration of a procedure.

$Id: ProcedureDecl.java,v 1.39 2007-10-04 19:58:04 burrill Exp $

Copyright 2007 by the Scale Compiler Group,
Department of Computer Science
University of Massachusetts,
Amherst MA. 01003, USA
All Rights Reserved.

Field Summary

Fields inherited from class scale.clef.decl.RoutineDecl

NOTPURE, PURE, PUREARGS, PUREGV, PUREGVA, PURESE, PURESGV

Constructor Summary

ProcedureDecl(java.lang.String name, ProcedureType type)
Create a new procedure declaration.

ProcedureDecl(java.lang.String name, ProcedureType type, int level, RoutineDecl parentRoutine)
Create a new procedure declaration.

ProcedureDecl(java.lang.String name, ProcedureType type, int level, RoutineDecl parentRoutine, Statement body)
Create a new procedure declaration.

ProcedureDecl(java.lang.String name, ProcedureType type, int level, Statement body)
Create a new procedure declaration.

Method Summary

Declaration	copy(java.lang.String name) Return a copy of this Declaration but with a different name.
Node	getChild(int i) Return the specified AST child of this node.
int	getLevel() Return the nested depth of this routine.
RoutineDecl	getParentRoutine() Return the enclosing routine of this routine.
boolean	isProcedureDecl() Return true if ProcedureDecl instance.
int	numChildren() Return the number of AST children of this node.
ProcedureDecl	returnProcedureDecl() Return a ProcedureDecl instance or null.
void	setLevel(int lev) Set the nested depth of this routine.
void	setParentRoutine(RoutineDecl parentRoutine) Set the enclosing routine of this routine.
java.lang.String	toStringSpecial() This method allows sub-classes to provide class specific stuff to the string.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.clef.decl.RoutineDecl

addCallee, addCaller, addCandidate, addCost, addProfiling, attachScribbleCFG, calls, cantInline, clearAST, getAddressRegister, getBody, getBuiltIn, getCallee, getCalleeCandidate, getCaller, getCallGraph, getCost, getDisplacement, getDisplayColorHint, getFtnResultVar, getProfCallCnt, getPurityLevel, getRoutineName, getScribbleCFG, getSignature, getSourceLineNumber, inlineSpecified, isBuiltIn, isMain, isPure, isRecursive, isReferenced, isRoutineDecl, isSpecification, numCalleeCandidates, numCallees, numCallers, printCallees, returnRoutineDecl, setAddressRegister, setBody, setBuiltIn, setCantInline, setCost, setDisplacement, setFtnResultVar, setInlineSpecified, setMain, setNoinlineSpecified, setProfCallCnt, setPurityLevel, setReferenced, setSignature, setSourceLineNumber, setUsesAlloca, setUsesSetjmp, setUsesVaStart, specifyCallGraph, usesAlloca, usesSetjmp, usesVaStart

Methods inherited from class scale.clef.decl.Declaration

accessibility, addressTaken, compareTo, getActualType, getAlias, getConstantValue, getCoreType, getDecl, getDisplayLabel, getDisplayShapeHint, getMode, getName, getPointedToCore, getStorageLoc, getTag, getType, getValueRegister, hashCode, hasHiddenAliases, inMemory, isCaseLabelDecl, isCommonBaseVariable, isConst, isEnumElementDecl, isEquivalenceDecl, isExceptionDecl, isFieldDecl, isFileDecl, isFormalDecl, isForwardProcedureDecl, isFtnResultVar, isGlobal, isLabelDecl, isRenamed, isRenamedVariableDecl, isStmtFtnDecl, isTemporary, isTypeDecl, isTypeName, isUnknownFormals, isValueDecl, isVariableDecl, isVirtual, isWeak, residency, returnCaseLabelDecl, returnEnumElementDecl, returnEquivalenceDecl, returnExceptionDecl, returnFieldDecl, returnFileDecl, returnFormalDecl, returnForwardProcedureDecl, returnLabelDecl, returnRenamedVariableDecl, returnStmtFtnDecl, returnTypeDecl, returnTypeName, returnUnknownFormals, returnValueDecl, returnVariableDecl, setAccessibility, setAddressTaken, setAlias, setName, setResidency, setStorageLoc, setTag, setType, setValueRegister, setVisibility, setWeak, valueRegMode, visibility

Methods inherited from class scale.clef.Node

setAnnotationLevel, setReportLevel, toString, toString, toStringChildren

Methods inherited from class scale.common.Root

addAnnotation, allAnnotations, allMatchingAnnotations, getAnnotation, getDisplayName, getDisplayString, getNodeCount, getNodeID, hasAnnotation, hasEqualAnnotation, removeAnnotation, removeAnnotations, toStringAnnotations, toStringClass, trace, trace, trace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcedureDecl

public ProcedureDecl(java.lang.String name,
                     ProcedureType type,
                     int level,
                     RoutineDecl parentRoutine,
                     Statement body)

Create a new procedure declaration.

Parameters:

name - is the procedure name

type - is the procedure type

level - is the nesting level of this procedure

parentRoutine - is the parent (enclosing) routine or null

body - is the body of the procedure

ProcedureDecl

public ProcedureDecl(java.lang.String name,
                     ProcedureType type,
                     int level,
                     RoutineDecl parentRoutine)

Create a new procedure declaration.

Parameters:

name - is the procedure name

type - is the procedure type

level - is the nesting level of this procedure

parentRoutine - is the parent (enclosing) routine or null

ProcedureDecl

public ProcedureDecl(java.lang.String name,
                     ProcedureType type)

Create a new procedure declaration.

Parameters:

name - is the procedure name

type - is the procedure type

ProcedureDecl

public ProcedureDecl(java.lang.String name,
                     ProcedureType type,
                     int level,
                     Statement body)

Create a new procedure declaration.

Parameters:

name - is the procedure name

type - is the procedure type

level - is the nesting level of this procedure

body - is the body of the procedure

Method Detail

toStringSpecial

public java.lang.String toStringSpecial()

Description copied from class: Node

This method allows sub-classes to provide class specific stuff to the string.

Overrides:

toStringSpecial in class RoutineDecl

visit

public void visit(Predicate p)

Description copied from class: Node

Process a node by calling its associated routine. See the "visitor" design pattern in Design Patterns: Elements of Reusable Object-Oriented Software by E. Gamma, et al, Addison Wesley, ISBN 0-201-63361-2.

Each class has a visit(Predicate p) method. For example, in class ABC:

   public void visit(Predicate p)
   {
     p.visitABC(this);
   }
 

and the class that implements Predicate has a method

   public void visitABC(Node n)
   {
     ABC a = (ABC) n;
     ...
   }
 

Thus, the class that implements Predicate can call

   n.visit(this);
 

where n is a Node sub-class without determining which specific sub-class n is. The visit pattern basically avoids implementing a large switch statement or defining different methods in each class for some purpose.

Overrides:

visit in class RoutineDecl

See Also:

Predicate

getLevel

public final int getLevel()

Return the nested depth of this routine. This value is currently always 0.

getParentRoutine

public final RoutineDecl getParentRoutine()

Return the enclosing routine of this routine. This value is currently always null.

setLevel

public final void setLevel(int lev)

Set the nested depth of this routine. This value is currently always 0.

setParentRoutine

public final void setParentRoutine(RoutineDecl parentRoutine)

Set the enclosing routine of this routine. This value is currently always null.

getChild

public Node getChild(int i)

Return the specified AST child of this node.

Overrides:

getChild in class RoutineDecl

numChildren

public int numChildren()

Return the number of AST children of this node.

Overrides:

numChildren in class RoutineDecl

copy

public Declaration copy(java.lang.String name)

Return a copy of this Declaration but with a different name.

Specified by:

copy in class Declaration

isProcedureDecl

public final boolean isProcedureDecl()

Description copied from class: Declaration

Return true if ProcedureDecl instance.

Overrides:

isProcedureDecl in class Declaration

returnProcedureDecl

public final ProcedureDecl returnProcedureDecl()

Description copied from class: Declaration

Return a ProcedureDecl instance or null.

Overrides:

returnProcedureDecl in class Declaration