scale.clef.stmt
Class LoopStmt

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

All Implemented Interfaces:

AnnotationInterface, DisplayNode

Direct Known Subclasses:

DoLoopStmt, TestLoopStmt

public class LoopStmt
extends Statement

This class is the abstract class for all loop statements.

$Id: LoopStmt.java,v 1.27 2006-06-28 16:39:03 burrill Exp $

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

Constructor Summary

LoopStmt(Statement stmt)

Method Summary

boolean	containsLoopStmt() Return true if this statement is a loop statement or contains a loop statement.
Node	getChild(int i) Return the specified AST child of this node.
Statement	getStmt() Return the statement that is iterated.
boolean	hasReturnStmt() Return true if this statement is, or contains, a return statement or a call to exit().
int	numChildren() Return the number of AST children of this node.
int	numTotalStmts() Return the number of statements represented by this statement.
protected void	setStmt(Statement stmt) Specify the statement that is iterated.
void	visit(Predicate p) Process a node by calling its associated routine.

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

LoopStmt

public LoopStmt(Statement stmt)

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 Statement

See Also:

Predicate

getStmt

public final Statement getStmt()

Return the statement that is iterated.

setStmt

protected final void setStmt(Statement stmt)

Specify the statement that is iterated.

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

hasReturnStmt

public boolean hasReturnStmt()

Return true if this statement is, or contains, a return statement or a call to exit().

Overrides:

hasReturnStmt in class Statement

numTotalStmts

public int numTotalStmts()

Return the number of statements represented by this statement. Most statements return 1. A block statement returns sum of the number of statements in each statement in the block.

Overrides:

numTotalStmts in class Statement

containsLoopStmt

public boolean containsLoopStmt()

Return true if this statement is a loop statement or contains a loop statement.

Overrides:

containsLoopStmt in class Statement