scale.clef.stmt
Class TestLoopStmt

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.stmt.Statement
              scale.clef.stmt.LoopStmt
                  scale.clef.stmt.TestLoopStmt

All Implemented Interfaces:

AnnotationInterface, DisplayNode

Direct Known Subclasses:

ForLoopStmt, RepeatUntilLoopStmt, RepeatWhileLoopStmt, WhileLoopStmt

public abstract class TestLoopStmt
extends LoopStmt

The TestLoopStmt class is the abstract class for loop statements that have a termination expression.

$Id: TestLoopStmt.java,v 1.26 2005-03-24 13:57:08 burrill Exp $

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

Examples include C-style for and while loops but not Fortran-style do loops.

Constructor Summary

TestLoopStmt(Statement s, Expression exp)

Method Summary

Node	getChild(int i) Return the specified AST child of this node.
Expression	getExpr()
int	numChildren() Return the number of AST children of this node.
protected void	setExpr(Expression expr) Return the test expression.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.clef.stmt.LoopStmt

containsLoopStmt, getStmt, hasReturnStmt, numTotalStmts, setStmt

Methods inherited from class scale.clef.stmt.Statement

dump, getDisplayColorHint, getDisplayLabel, getDisplayShapeHint, getPragma, getSourceLineNumber, setPragma, setSourceLineNumber

Methods inherited from class scale.clef.Node

getCoreType, getDecl, getType, setAnnotationLevel, setReportLevel, toString, toString, toStringChildren, toStringSpecial

Methods inherited from class scale.common.Root

addAnnotation, allAnnotations, allMatchingAnnotations, getAnnotation, getDisplayName, getDisplayString, getNodeCount, getNodeID, hasAnnotation, hasEqualAnnotation, hashCode, 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

TestLoopStmt

public TestLoopStmt(Statement s,
                    Expression exp)

Method Detail

getExpr

public final Expression getExpr()

setExpr

protected final void setExpr(Expression expr)

Return the test expression.

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 LoopStmt

See Also:

Predicate

getChild

public Node getChild(int i)

Return the specified AST child of this node.

Overrides:

getChild in class LoopStmt

numChildren

public int numChildren()

Return the number of AST children of this node.

Overrides:

numChildren in class LoopStmt