scale.clef.expr
Class SizeofLiteral

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

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class SizeofLiteral
extends Literal

A class which represents a literal value that is the size of some type or variable.

$Id: SizeofLiteral.java,v 1.32 2005-06-16 20:56:29 burrill Exp $

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

Constructor Summary

SizeofLiteral(Type type, Node v)
Construct a representation of the C sizeof() function

Method Summary

long	canonical() Return a unique value representing this particular expression.
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.
Literal	getConstantValue() Return the constant value of the expression.
java.lang.String	getGenericValue() Get the string version of the literal using pseudo-C syntax.
Type	getSizeofType() Return the type whose size is represented.
boolean	isOne() Return true if the value of this literal is known to be one.
int	linearity() Return linearity of literal.
protected void	setValue(Node n) Specify the item whose size is to be represented.
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, getCount, getDeclList, getDisplayLabel, getElement, isZero

Methods inherited from class scale.clef.expr.Expression

containsDeclaration, getCoreType, getDisplayColorHint, getDisplayShapeHint, getPointedToCore, getType, hasTrueFalseResult, 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

Constructor Detail

SizeofLiteral

public SizeofLiteral(Type type,
                     Node v)

Construct a representation of the C sizeof() function

Parameters:

type - is the type of the expression - usually an integer type

v - is either a type or a declaration

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()

Get the string version of the literal using pseudo-C syntax. The type of Declaraction is displayed using Clef node display syntax.

Overrides:

getGenericValue in class Literal

Returns:

a String already converted for display.

getSizeofType

public Type getSizeofType()

Return the type whose size is represented.

setValue

protected final void setValue(Node n)

Specify the item whose size is to be represented.

getConstantValue

public Literal getConstantValue()

Return the constant value of the expression.

Overrides:

getConstantValue in class Literal

See Also:

Lattice

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

isOne

public boolean isOne()

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

Overrides:

isOne in class Literal