scale.clef.decl
Class TypeDecl

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

All Implemented Interfaces:

java.lang.Comparable, AnnotationInterface, DisplayNode

public class TypeDecl
extends Declaration

A class representing the declaration of a new type.

$Id: TypeDecl.java,v 1.26 2007-03-21 13:31:52 burrill Exp $

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

See Also:

TypeName

Constructor Summary

TypeDecl(java.lang.String name, Type type)

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.
boolean	isTypeDecl() Return true if TypeDecl instance.
int	numChildren() Return the number of AST children of this node.
TypeDecl	returnTypeDecl() Return a TypeDecl 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, isLabelDecl, isProcedureDecl, isPure, isReferenced, isRenamed, isRenamedVariableDecl, isRoutineDecl, isStmtFtnDecl, isTemporary, isTypeName, isUnknownFormals, isValueDecl, isVariableDecl, isVirtual, isWeak, residency, returnCaseLabelDecl, returnEnumElementDecl, returnEquivalenceDecl, returnExceptionDecl, returnFieldDecl, returnFileDecl, returnFormalDecl, returnForwardProcedureDecl, returnLabelDecl, returnProcedureDecl, returnRenamedVariableDecl, returnRoutineDecl, returnStmtFtnDecl, 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

getSourceLineNumber, 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

TypeDecl

public TypeDecl(java.lang.String name,
                Type 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 Declaration

See Also:

Predicate

getChild

public Node getChild(int i)

Return the specified AST child of this node.

Overrides:

getChild in class Node

numChildren

public int numChildren()

Return the number of AST children of this node.

Overrides:

numChildren in class Node

copy

public Declaration copy(java.lang.String name)

Description copied from class: Declaration

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

Specified by:

copy in class Declaration

isTypeDecl

public final boolean isTypeDecl()

Description copied from class: Declaration

Return true if TypeDecl instance.

Overrides:

isTypeDecl in class Declaration

returnTypeDecl

public final TypeDecl returnTypeDecl()

Description copied from class: Declaration

Return a TypeDecl instance or null.

Overrides:

returnTypeDecl in class Declaration