scale.clef.stmt
Class ReturnStmt

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

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class ReturnStmt
extends Statement

This class represents C-style return statements.

$Id: ReturnStmt.java,v 1.26 2006-06-06 14:49:20 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

ReturnStmt(Expression exp)

Method Summary

Node	getChild(int i) Return the specified AST child of this node.
Expression	getExpr() Return the expression that specifies the return value.
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.
protected void	setExpr(Expression expr) Set the expression that specifies the return value.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.clef.stmt.Statement

containsLoopStmt, dump, getDisplayColorHint, getDisplayLabel, getDisplayShapeHint, getPragma, getSourceLineNumber, numTotalStmts, 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

ReturnStmt

public ReturnStmt(Expression exp)

Parameters:

exp - the expression representing the value (if any) returned.

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

getExpr

public final Expression getExpr()

Return the expression that specifies the return value.

setExpr

protected final void setExpr(Expression expr)

Set the expression that specifies the return value.

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