scale.clef.expr
Class BitShiftAssignmentOp

java.lang.Object
  extended by scale.common.Root
      extended by scale.clef.Node
          extended by scale.clef.expr.Expression
              extended by scale.clef.expr.DyadicOp
                  extended by scale.clef.expr.AssignmentOp
                      extended by scale.clef.expr.CompoundAssignmentOp
                          extended by scale.clef.expr.BitShiftAssignmentOp
All Implemented Interfaces:
AnnotationInterface, DisplayNode

public class BitShiftAssignmentOp
extends CompoundAssignmentOp

This class represents x <<= y and x >>= y.

$Id: BitShiftAssignmentOp.java,v 1.13 2006-12-18 21:36:48 burrill Exp $

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

Note that x <<= y is not equivalent to x = x << y when x is a an expression with side effects.

See Also:
BitShiftOp

Constructor Summary
BitShiftAssignmentOp(Type type, Expression lhs, Expression ra, ShiftMode mode)
           
BitShiftAssignmentOp(Type type, Type calcType, Expression lhs, Expression ra, ShiftMode mode)
           
 
Method Summary
 boolean equivalent(java.lang.Object exp)
          Return true if the two expressions are equivalent.
 ShiftMode getShiftMode()
          Return the shift mode.
 void setShiftMode(ShiftMode mode)
          Set the shift mode to C or Java.
 java.lang.String toStringSpecial()
          This method allows sub-classes to provide class specific stuff to the string.
 void visit(Predicate p)
          Process a node by calling its associated routine.
 
Methods inherited from class scale.clef.expr.CompoundAssignmentOp
getCalcType
 
Methods inherited from class scale.clef.expr.DyadicOp
containsDeclaration, getChild, getDeclList, getExpr1, getExpr2, getLhs, getRhs, isSimpleOp, numChildren, setExpr1, setExpr2, setLhs, setRhs
 
Methods inherited from class scale.clef.expr.Expression
canonical, getConstantValue, getCoreType, getDisplayColorHint, getDisplayLabel, getDisplayShapeHint, getPointedToCore, getType, hasTrueFalseResult, setType
 
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

BitShiftAssignmentOp

public BitShiftAssignmentOp(Type type,
                            Type calcType,
                            Expression lhs,
                            Expression ra,
                            ShiftMode mode)
Parameters:
type - is the type of the expression
calcType - is the type required for the right-hand-side computation
lhs - is the left-hand-side expression of the assignment
ra - is right argument to the right-hand-side expression of the assignment
mode - is the shift operation - right, left, etc.
See Also:
ShiftMode

BitShiftAssignmentOp

public BitShiftAssignmentOp(Type type,
                            Expression lhs,
                            Expression ra,
                            ShiftMode mode)
Parameters:
mode - is the shift operation - right, left, etc.
See Also:
BitShiftOp
Method Detail

equivalent

public boolean equivalent(java.lang.Object exp)
Return true if the two expressions are equivalent.

Overrides:
equivalent in class DyadicOp

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 CompoundAssignmentOp
See Also:
Predicate

setShiftMode

public void setShiftMode(ShiftMode mode)
Set the shift mode to C or Java. Default is C.

See Also:
BitShiftOp

getShiftMode

public ShiftMode getShiftMode()
Return the shift mode.

See Also:
BitShiftOp

toStringSpecial

public java.lang.String toStringSpecial()
Description copied from class: Node
This method allows sub-classes to provide class specific stuff to the string.

Overrides:
toStringSpecial in class Expression