scale.clef.expr
Class SubstringOp

java.lang.Object
  scale.common.Root
      scale.clef.Node
          scale.clef.expr.Expression
              scale.clef.expr.TernaryOp
                  scale.clef.expr.SubstringOp

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public final class SubstringOp
extends TernaryOp

A class which represents the substring operationapplied to a Fortran CHARACTER variable.

$Id: SubstringOp.java,v 1.2 2007-10-04 19:58:07 burrill Exp $

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

Constructor Summary

SubstringOp(Expression str, Expression first, Expression last)
Create an substring instance of a Fortran CHARACTER string from another string.

Method Summary

static FortranCharType	calcType(Expression fci, Expression lci) Return the FortranCharType required for the specified starting and ending character indexes.
Literal	getConstantValue() Return the constant value of the expression.
Expression	getFirst() Return the expression that specifies the index of the starting character (1 -origin).
Expression	getLast() Return the expression that specifies the index of the ending character (1 -origin).
Expression	getStr() Return the string expression.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.clef.expr.TernaryOp

containsDeclaration, equivalent, getChild, getDeclList, getExpr1, getExpr2, getExpr3, isSimpleOp, numChildren, setExpr1, setExpr2, setExpr3

Methods inherited from class scale.clef.expr.Expression

canonical, getCoreType, getDisplayColorHint, getDisplayLabel, getDisplayShapeHint, getPointedToCore, getType, hasTrueFalseResult, setType, toStringSpecial

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

SubstringOp

public SubstringOp(Expression str,
                   Expression first,
                   Expression last)

Create an substring instance of a Fortran CHARACTER string from another string. The type is computed.

Parameters:

str - specifies the CHARACTER string

first - specifies the index of the starting character (1-origin indexing)

last - specifies the index of the ending character (1-origin indexing)

Method Detail

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 TernaryOp

See Also:

Predicate

getStr

public final Expression getStr()

Return the string expression.

getFirst

public final Expression getFirst()

Return the expression that specifies the index of the starting character (1 -origin).

getLast

public final Expression getLast()

Return the expression that specifies the index of the ending character (1 -origin).

calcType

public static FortranCharType calcType(Expression fci,
                                       Expression lci)

Return the FortranCharType required for the specified starting and ending character indexes.

getConstantValue

public Literal getConstantValue()

Return the constant value of the expression.

Overrides:

getConstantValue in class Expression

See Also:

Lattice