scale.clef.stmt
Class DoLoopStmt

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

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class DoLoopStmt
extends LoopStmt

This class represents the Fortran 77 DO statement.

$Id: DoLoopStmt.java,v 1.34 2007-01-31 18:36:56 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

DoLoopStmt(Expression idx, Statement s, Expression i, Expression t, Expression ic)

Method Summary

void	dump(java.lang.String indents, java.io.PrintStream out)
Node	getChild(int i) Return the specified AST child of this node.
Expression	getExprInc() Return the increment amount.
Expression	getExprInit() Return the initial loop index value.
Expression	getExprTerm() Return the maximum value of the index.
Expression	getIndex() Return the loop index expression.
int	numChildren() Return the number of AST children of this node.
protected void	setExprInc(Expression inc) Specify the increment amount.
protected void	setExprInit(Expression init)
protected void	setExprTerm(Expression term) Specify the maximum value of the index.
protected void	setIndex(Expression index) Specify the initial loop index value.
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

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

DoLoopStmt

public DoLoopStmt(Expression idx,
                  Statement s,
                  Expression i,
                  Expression t,
                  Expression ic)

Parameters:

idx - - the value expression representing the index variable

s - - the statement to be iterated.

i - - the initial value of the index.

t - - the final value of the index.

ic - - the step value for the index.

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 LoopStmt

See Also:

Predicate

getIndex

public final Expression getIndex()

Return the loop index expression.

getExprInit

public final Expression getExprInit()

Return the initial loop index value.

getExprTerm

public final Expression getExprTerm()

Return the maximum value of the index.

getExprInc

public final Expression getExprInc()

Return the increment amount.

setIndex

protected final void setIndex(Expression index)

Specify the initial loop index value.

setExprInit

protected final void setExprInit(Expression init)

setExprTerm

protected final void setExprTerm(Expression term)

Specify the maximum value of the index.

setExprInc

protected final void setExprInc(Expression inc)

Specify the increment amount.

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

dump

public void dump(java.lang.String indents,
                 java.io.PrintStream out)

Overrides:

dump in class Statement