scale.score.expr
Class VaStartExpr

java.lang.Object
  scale.common.Root
      scale.score.Note
          scale.score.expr.Expr
              scale.score.expr.VarArgExpr
                  scale.score.expr.VaStartExpr

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class VaStartExpr
extends VarArgExpr

A class which represents the va_start(va_list, parmN) C construct in Score.

$Id: VaStartExpr.java,v 1.25 2007-01-05 19:06:46 burrill Exp $

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

Field Summary

Fields inherited from class scale.score.expr.Expr

fpReorder, SE_DOMAIN, SE_NONE, SE_OVERFLOW, SE_STATE

Constructor Summary

VaStartExpr(Expr va_list, FormalDecl pn)

Method Summary

Expr	copy() Perform a deep copy of the expression tree.
boolean	equivalent(Expr exp) Return true if the expressions are equivalent.
int	executionCostEstimate() Return a relative cost estimate for executing the expression.
FormalDecl	getParmN() Return the reference parameter of the calling function.
protected void	setParmN(FormalDecl pn) Specify the reference parameter of the calling function.
java.lang.String	toStringSpecial() Return any special information of a node that is not a child or annotation.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.score.expr.VarArgExpr

containsDeclaration, dependsOnDeclaration, findCriticalChord, getDeclList, getExprList, getLoadExprList, getOperand, getOperandArray, getVaList, loopClean, numOperands, optimizationCandidate, pushOperands, recordRefs, removeRefs, removeUseDef, replaceDecl, setOperand, sideEffects, unlinkExpression, validate

Methods inherited from class scale.score.expr.Expr

addCast, addCast, canonical, changeInDataEdge, conditionalCopy, conditionalUnlinkExpression, deleteOutDataEdge, executionOrder, executionOrdinal, findLinearCoefficient, findSubscriptExpr, getAffineExpr, getAffineRepresentation, getAliasAnnote, getCall, getConstantValue, getConstantValue, getCoreType, getCriticalChord, getDefExpr, getDisplayColorHint, getDisplayLabel, getDisplayShapeHint, getDualExpr, getInDataEdge, getInDataEdgeArray, getLoopHeader, getLow, getLValue, getOutDataEdge, getPointedToCore, getReference, getReuseLevel, getRValue, getType, getUseDef, hasTrueFalseResult, isCast, isDefined, isDefined, isLiteralExpr, isLoopInvariant, isMatchExpr, isMemoryDef, isMemRefExpr, isScalar, isSimpleExpr, mayGenerateCall, numInDataEdges, reduce, removeDualExprs, setCrossloopReuse, setOutDataEdge, setSpatialReuse, setStep, setTemporalReuse, setType, setUseDef, validLValue

Methods inherited from class scale.score.Note

getChord, getEssentialUse, setAnnotationLevel, setReportLevel, toString

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

VaStartExpr

public VaStartExpr(Expr va_list,
                   FormalDecl pn)

Method Detail

equivalent

public boolean equivalent(Expr exp)

Return true if the expressions are equivalent. This method should be called by the equivalent() method of the derived classes.

Overrides:

equivalent in class VarArgExpr

Returns:

true if classes are identical and the core types are equivalent

copy

public Expr copy()

Description copied from class: Expr

Perform a deep copy of the expression tree. By deep copy, we mean that copies are made of the expression tree.

Specified by:

copy in class Expr

Returns:

a copy of this expression

visit

public void visit(Predicate p)

Description copied from class: Note

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(Note n)
   {
     ABC a = (ABC) n;
     ...
   }
 

Thus, the class that implements Predicate can call

   n.visit(this);
 

where n is a Note 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.

Specified by:

visit in class Note

See Also:

Predicate

getParmN

public final FormalDecl getParmN()

Return the reference parameter of the calling function.

setParmN

protected final void setParmN(FormalDecl pn)

Specify the reference parameter of the calling function.

executionCostEstimate

public int executionCostEstimate()

Return a relative cost estimate for executing the expression.

Specified by:

executionCostEstimate in class Note

toStringSpecial

public java.lang.String toStringSpecial()

Description copied from class: Root

Return any special information of a node that is not a child or annotation. This method is meant to be overridden by nodes that need to provide special output.

Overrides:

toStringSpecial in class Expr