scale.clef.decl
Class FileDecl

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

All Implemented Interfaces:

java.lang.Comparable, AnnotationInterface, DisplayNode

public class FileDecl
extends Declaration

A FileDecl is a collection of all the declarations in a source file.

$Id: FileDecl.java,v 1.40 2007-05-10 16:48:02 burrill Exp $

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

Constructor Summary

FileDecl(java.lang.String name)

FileDecl(java.lang.String name, Vector<Declaration> decls)

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.
Declaration	getDecl(int i) Return the i-th declaration.
int	getNumDecls() Return the number of declarations.
boolean	isFileDecl() Return true if FileDecl instance.
int	numChildren() Return the number of AST children of this node.
FileDecl	returnFileDecl() a FileDecl instance or null.
void	setDecls(Vector<Declaration> decls) Specify the set of declarations that comprise the source file.
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, isFormalDecl, isForwardProcedureDecl, isFtnResultVar, isGlobal, isLabelDecl, isProcedureDecl, isPure, isReferenced, isRenamed, isRenamedVariableDecl, isRoutineDecl, isStmtFtnDecl, isTemporary, isTypeDecl, isTypeName, isUnknownFormals, isValueDecl, isVariableDecl, isVirtual, isWeak, residency, returnCaseLabelDecl, returnEnumElementDecl, returnEquivalenceDecl, returnExceptionDecl, returnFieldDecl, returnFormalDecl, returnForwardProcedureDecl, returnLabelDecl, 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

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

FileDecl

public FileDecl(java.lang.String name)

FileDecl

public FileDecl(java.lang.String name,
                Vector<Declaration> decls)

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

setDecls

public void setDecls(Vector<Declaration> decls)

Specify the set of declarations that comprise the source file.

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

getDecl

public final Declaration getDecl(int i)

Return the i-th declaration.

getNumDecls

public final int getNumDecls()

Return the number of declarations.

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

isFileDecl

public final boolean isFileDecl()

Description copied from class: Declaration

Return true if FileDecl instance.

Overrides:

isFileDecl in class Declaration

returnFileDecl

public final FileDecl returnFileDecl()

Description copied from class: Declaration

a FileDecl instance or null.

Overrides:

returnFileDecl in class Declaration