scale.clef.expr
Class BitShiftOp

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.expr.Expression
              scale.clef.expr.DyadicOp
                  scale.clef.expr.BitShiftOp

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class BitShiftOp
extends DyadicOp

The BitShiftOp class is the class for all bit shifting operations.

$Id: BitShiftOp.java,v 1.18 2007-10-04 19:58:05 burrill Exp $

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

Constructor Summary

BitShiftOp(Type type, Expression e1, Expression e2, ShiftMode mode)

Method Summary

boolean	equivalent(java.lang.Object exp) Return true if the two expressions are equivalent.
Literal	getConstantValue() Return the constant value of the expression.
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.DyadicOp

containsDeclaration, getChild, getDeclList, getExpr1, getExpr2, getLhs, getRhs, isSimpleOp, numChildren, setExpr1, setExpr2, setLhs, setRhs

Methods inherited from class scale.clef.expr.Expression

canonical, 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

BitShiftOp

public BitShiftOp(Type type,
                  Expression e1,
                  Expression e2,
                  ShiftMode mode)

Parameters:

mode - is the shift operation - right, left, etc.

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 DyadicOp

See Also:

Predicate

setShiftMode

public void setShiftMode(ShiftMode mode)

Set the shift mode to C or Java. Default is C.

getShiftMode

public ShiftMode getShiftMode()

Return the shift mode.

See Also:

ShiftMode

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

getConstantValue

public Literal getConstantValue()

Return the constant value of the expression.

Overrides:

getConstantValue in class Expression

See Also:

Lattice