scale.clef.decl
Class LabelDecl

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.decl.Declaration
              scale.clef.decl.LabelDecl

All Implemented Interfaces:

java.lang.Comparable, AnnotationInterface, DisplayNode

Direct Known Subclasses:

CaseLabelDecl

public class LabelDecl
extends Declaration

This class represents a label in a program.

$Id: LabelDecl.java,v 1.24 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.

Constructor Summary

LabelDecl(java.lang.String name)

Method Summary

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

Methods inherited from class scale.clef.decl.Declaration

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

Methods inherited from class scale.clef.Node

getChild, getSourceLineNumber, numChildren, setAnnotationLevel, setReportLevel, setSourceLineNumber, 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

LabelDecl

public LabelDecl(java.lang.String name)

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 Declaration

See Also:

Predicate

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

isLabelDecl

public final boolean isLabelDecl()

Description copied from class: Declaration

Return true if LabelDecl instance.

Overrides:

isLabelDecl in class Declaration

returnLabelDecl

public final LabelDecl returnLabelDecl()

Description copied from class: Declaration

R a LabelDecl instance or null.

Overrides:

returnLabelDecl in class Declaration