scale.clef.decl
Class ForwardProcedureDecl

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

All Implemented Interfaces:

java.lang.Comparable, AnnotationInterface, DisplayNode

public class ForwardProcedureDecl
extends ProcedureDecl

Un-used.

$Id: ForwardProcedureDecl.java,v 1.26 2007-03-21 13:31:51 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

ForwardProcedureDecl(java.lang.String name, ProcedureType type)

Method Summary

Declaration	copy(java.lang.String name) Return a copy of this Declaration but with a different name.
boolean	isForwardProcedureDecl() Return true if ForwardProcedureDecl instance.
ForwardProcedureDecl	returnForwardProcedureDecl() Return a For a ForwardProcedureDecl instance or null.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.clef.decl.ProcedureDecl

getChild, getLevel, getParentRoutine, isProcedureDecl, numChildren, returnProcedureDecl, setLevel, setParentRoutine, toStringSpecial

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, isFtnResultVar, isGlobal, isLabelDecl, isRenamed, isRenamedVariableDecl, isStmtFtnDecl, isTemporary, isTypeDecl, isTypeName, isUnknownFormals, isValueDecl, isVariableDecl, isVirtual, isWeak, residency, returnCaseLabelDecl, returnEnumElementDecl, returnEquivalenceDecl, returnExceptionDecl, returnFieldDecl, returnFileDecl, returnFormalDecl, 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

ForwardProcedureDecl

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

Method Detail

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 ProcedureDecl

See Also:

Predicate

copy

public Declaration copy(java.lang.String name)

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

Overrides:

copy in class ProcedureDecl

isForwardProcedureDecl

public final boolean isForwardProcedureDecl()

Description copied from class: Declaration

Return true if ForwardProcedureDecl instance.

Overrides:

isForwardProcedureDecl in class Declaration

returnForwardProcedureDecl

public final ForwardProcedureDecl returnForwardProcedureDecl()

Description copied from class: Declaration

Return a For a ForwardProcedureDecl instance or null.

Overrides:

returnForwardProcedureDecl in class Declaration