scale.clef.expr
Class CallOp

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.expr.Expression
              scale.clef.expr.CallOp

All Implemented Interfaces:

AnnotationInterface, DisplayNode

Direct Known Subclasses:

CallFunctionOp

public abstract class CallOp
extends Expression

A class which represents a generic routine call expression.

$Id: CallOp.java,v 1.44 2007-08-28 17:58:20 burrill Exp $

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

The result type is specified via the constructor and should be the result of the procedure call.

Constructor Summary

CallOp(Type returnType, Expression routine, Vector<Expression> argList)

Method Summary

boolean	containsDeclaration(Declaration decl) Return true if this expression contains a reference to the variable.
boolean	equivalent(java.lang.Object exp) Return true if the two expressions are equivalent.
Expression	getArg(int i) Return the i-th argument to the call.
Node	getChild(int i) Return the specified AST child of this node.
void	getDeclList(java.util.AbstractCollection<Declaration> varList) Add all declarations referenced in this expression to the collection.
int	getNumArgs() Return the number of arguments to the call.
ProcedureType	getProcedureInfo() Return the procedure type node of the callee.
Expression	getRoutine() Return the expression that specifies what is called.
boolean	isSimpleOp() Return true if compilation of this expression will not result in the generation of a CFG node.
int	numChildren() Return the number of AST children of this node.
void	setArg(Expression arg, int i) set the i-th argument to the call.
protected void	setArgList(Vector<Expression> argList) Specify the arguments of the call.
protected void	setRoutine(Expression routine) Specify the expression that specifies what is called.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.clef.expr.Expression

canonical, getConstantValue, getCoreType, getDisplayColorHint, getDisplayLabel, getDisplayShapeHint, getPointedToCore, getType, hasTrueFalseResult, setType, toStringSpecial

Methods inherited from class scale.clef.Node

getDecl, getSourceLineNumber, setAnnotationLevel, setReportLevel, setSourceLineNumber, toString, toString, toStringChildren

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

CallOp

public CallOp(Type returnType,
              Expression routine,
              Vector<Expression> argList)

Method Detail

equivalent

public boolean equivalent(java.lang.Object exp)

Return true if the two expressions are equivalent.

Overrides:

equivalent in class 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 Expression

See Also:

Predicate

getRoutine

public final Expression getRoutine()

Return the expression that specifies what is called.

getArg

public final Expression getArg(int i)

Return the i-th argument to the call.

setArg

public final void setArg(Expression arg,
                         int i)

set the i-th argument to the call.

getNumArgs

public final int getNumArgs()

Return the number of arguments to the call.

setRoutine

protected final void setRoutine(Expression routine)

Specify the expression that specifies what is called.

setArgList

protected final void setArgList(Vector<Expression> argList)

Specify the arguments of the call.

getProcedureInfo

public final ProcedureType getProcedureInfo()

Return the procedure type node of the callee. The expression representing the routine should either (1) be an expression of type ProcedureType or (2) be a pointer to a ProcedureType.

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

isSimpleOp

public boolean isSimpleOp()

Description copied from class: Expression

Return true if compilation of this expression will not result in the generation of a CFG node. For example, (a && b) may require a branch to represent and i++ requires a store.

Overrides:

isSimpleOp in class Expression

containsDeclaration

public boolean containsDeclaration(Declaration decl)

Return true if this expression contains a reference to the variable.

Overrides:

containsDeclaration in class Expression

getDeclList

public void getDeclList(java.util.AbstractCollection<Declaration> varList)

Description copied from class: Expression

Add all declarations referenced in this expression to the collection.

Specified by:

getDeclList in class Expression