scale.clef.expr
Class StringLiteral

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

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class StringLiteral
extends Literal

A class which represents a literal string value.

$Id: StringLiteral.java,v 1.44 2007-10-04 19:58:06 burrill Exp $

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

The result type is the type of the literal.

Constructor Summary

StringLiteral(Type type, java.lang.String v)

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	getCount() Return the number of elements in the Literal.
java.lang.String	getDisplayLabel() Return short description of current node.
java.lang.String	getGenericValue() Get the string version of the literal using C syntax.
java.lang.String	getString() Return the String value.
java.lang.String	getStringValue() Return the value of the literal.
protected void	setValue(java.lang.String value) Specify the String value.
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

executionCostEstimate, findCoefficient, formatRealValue, getConstantValue, getDeclList, getElement, isOne, isZero, linearity

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

StringLiteral

public StringLiteral(Type type,
                     java.lang.String v)

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 C syntax.

Overrides:

getGenericValue in class Literal

Returns:

a String already converted for display using C syntax.

getDisplayLabel

public java.lang.String getDisplayLabel()

Return short description of current node.

Specified by:

getDisplayLabel in interface DisplayNode

Overrides:

getDisplayLabel in class Literal

getStringValue

public java.lang.String getStringValue()

Return the value of the literal.

getString

public java.lang.String getString()

Return the String value.

setValue

protected final void setValue(java.lang.String value)

Specify the String value.

getCount

public int getCount()

Return the number of elements in the Literal.

Overrides:

getCount in class Literal

canonical

public long canonical()

Return a unique value representing this particular expression.

Overrides:

canonical in class Expression