scale.clef.expr
Class IntLiteral

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.expr.Expression
              scale.clef.expr.Literal
                  scale.clef.expr.IntLiteral

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class IntLiteral
extends Literal

A class which represents a integer literal value including address constants.

$Id: IntLiteral.java,v 1.50 2007-03-21 13:31:53 burrill Exp $

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

Integer literals include address constants.

Field Summary

static boolean

useDecimal If true, getGenericValue will return unsigned values, between 0 and 1000, in decimal instead of hex notation.

Constructor Summary

IntLiteral(Type type, long value)

Method Summary

long	canonical() Return a unique value representing this particular expression.
double	convertToDouble() Return the value of the literal as a double value.
float	convertToFloat() Return the value of the literal as a double value.
boolean	equivalent(java.lang.Object exp) Return true if the two expressions are equivalent.
int	executionCostEstimate() Return a relative cost estimate for executing the expression.
int	findCoefficient() Return the coefficient value.
java.lang.String	getGenericValue() Return a String already converted for display using C syntax.
long	getLongValue() Return the value of the integer literal.
boolean	hasTrueFalseResult() Return true if the result of the expression is either true (1) or false (0).
boolean	isOne() Return true if the value of this literal is known to be one.
boolean	isZero() Return true if the value of this literal is known to be zero.
int	linearity() Return linearity of literal.
void	setValue(long value) Specify the value of this literal.
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.Literal

formatRealValue, getConstantValue, getCount, getDeclList, getDisplayLabel, getElement

Methods inherited from class scale.clef.expr.Expression

containsDeclaration, getCoreType, getDisplayColorHint, getDisplayShapeHint, getPointedToCore, getType, isSimpleOp, setType

Methods inherited from class scale.clef.Node

getChild, getDecl, getSourceLineNumber, numChildren, 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

Field Detail

useDecimal

public static boolean useDecimal

If true, getGenericValue will return unsigned values, between 0 and 1000, in decimal instead of hex notation. This switch is used for debugging.

Constructor Detail

IntLiteral

public IntLiteral(Type type,
                  long value)

Method Detail

equivalent

public boolean equivalent(java.lang.Object exp)

Return true if the two expressions are equivalent.

Overrides:

equivalent in class Expression

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

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 Literal

See Also:

Predicate

getGenericValue

public final java.lang.String getGenericValue()

Return a String already converted for display using C syntax. Get the string version of the literal using C syntax.

Overrides:

getGenericValue in class Literal

Returns:

a String representing the literal value and uses C syntax

setValue

public final void setValue(long value)

Specify the value of this literal. This method must be used with care. If the literal has been memoized (see LiteralMap) using this method will cause hard to find problems.

getLongValue

public long getLongValue()

Return the value of the integer literal.

canonical

public long canonical()

Return a unique value representing this particular expression.

Overrides:

canonical in class Expression

linearity

public int linearity()

Return linearity of literal. Integer literals have linearity of 0. All other literals have linearity of 2.

Overrides:

linearity in class Literal

findCoefficient

public int findCoefficient()

Return the coefficient value.

Overrides:

findCoefficient in class Literal

executionCostEstimate

public int executionCostEstimate()

Return a relative cost estimate for executing the expression.

Overrides:

executionCostEstimate in class Literal

isZero

public boolean isZero()

Return true if the value of this literal is known to be zero.

Overrides:

isZero in class Literal

isOne

public boolean isOne()

Return true if the value of this literal is known to be one.

Overrides:

isOne in class Literal

hasTrueFalseResult

public boolean hasTrueFalseResult()

Return true if the result of the expression is either true (1) or false (0).

Overrides:

hasTrueFalseResult in class Expression

convertToDouble

public double convertToDouble()

Return the value of the literal as a double value. Care must be taken when converting unsigned long values.

convertToFloat

public float convertToFloat()

Return the value of the literal as a double value. Care must be taken when converting unsigned long values.