scale.score.chords
Class MarkerChord

java.lang.Object
  scale.common.Root
      scale.score.Note
          scale.score.chords.Chord
              scale.score.chords.SequentialChord
                  scale.score.chords.MarkerChord

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public class MarkerChord
extends SequentialChord

This class represents a "marker" node in the CFG.

$Id: MarkerChord.java,v 1.2 2007-03-21 13:32:12 burrill Exp $

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

A marker records some information needed by the compiler. No code may generated for the node.

Field Summary

Fields inherited from class scale.score.chords.Chord

lineNumber

Constructor Summary

MarkerChord(java.lang.Object object, long flags)
Create a MarkerChord.

MarkerChord(java.lang.Object object, long flags, Chord next)
Create a MarkerChord.

Method Summary

Chord	copy() Make a copy of this CFG node with the same out-going CFG edges.
DColor	getDisplayColorHint() Return a String specifying the color to use for coloring this node in a graphical display.
long	getFlags()
java.lang.Object	getObject()
boolean	isMarker() Return true if this is a marker chord.
boolean	isSpecial() Return true if this is chord was added for the convenience of the compiler and does not correspond to actual source code in the user program.
void	visit(Predicate pred) Process a node by calling its associated routine.

Methods inherited from class scale.score.chords.SequentialChord

changeOutCfgEdge, clearEdge, clearEdgeMarkers, deleteInDataEdges, deleteOutCfgEdges, edgeMarked, executionCostEstimate, getDeclList, getExprList, getLoadExprList, getNextChord, getOutCfgEdge, getOutCfgEdgeArray, getTarget, indexOfOutCfgEdge, isLastInBasicBlock, isSequential, linkSubgraph, linkTo, markEdge, numOutCfgEdges, pushAllOutCfgEdges, pushOutCfgEdges, pushOutCfgEdges, pushSortedOutCfgEdges, pushSortedOutCfgEdges, removeUseDef, replaceDecl, replaceOutCfgEdge, setTarget, setTargetUnsafe

Methods inherited from class scale.score.chords.Chord

addInCfgEdge, changeInDataEdge, changeParentOutCfgEdge, copySourceLine, deadCFGNodes, deletedCFGNodes, deleteInCfgEdge, executionOrder, expungeFromCfg, extractFromCfg, findLoopExit, findPhiChords, firstInBasicBlock, getCall, getDefExpr, getDisplayLabel, getDisplayShapeHint, getFirstInCfgEdge, getInCfgEdge, getInCfgEdge, getInCfgEdgeArray, getInDataEdge, getInDataEdgeArray, getLabel, getLoopHeader, getLoopHeader, getLoopNumber, getSourceLineNumber, gotoCFGNodes, inBasicBlock, indexOfInCfgEdge, insertAfterOutCfg, insertBeforeInCfg, isAssignChord, isBranch, isExprChord, isFirstInBasicBlock, isLoopExit, isLoopHeader, isLoopPreHeader, isLoopTail, isPhiExpr, lastInBasicBlock, loopClean, nextVisit, nthIndexOfInCfgEdge, nullCFGNodes, numInCfgEdges, numInDataEdges, numOfInCfgEdge, parentsFinished, parentsVisited, pushAllInCfgEdges, pushChordWhenReady, pushChordWhenReady, pushInCfgEdges, pushInCfgEdges, pushInDataEdges, recordRefs, removeDeadCode, removeDualExprs, removeFromCfg, removeRefs, reorderInCfgEdgesOfCopy, replaceInCfgEdge, setLabel, setSourceLineNumber, setVisited, toStringSpecial, unlinkChord, visited

Methods inherited from class scale.score.Note

getChord, getEssentialUse, setAnnotationLevel, setReportLevel, toString, validate

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

MarkerChord

public MarkerChord(java.lang.Object object,
                   long flags,
                   Chord next)

Create a MarkerChord.

Parameters:

object - is some Object or null

flags - specifies the flags of marker

MarkerChord

public MarkerChord(java.lang.Object object,
                   long flags)

Create a MarkerChord.

Parameters:

object - is some Object or null

flags - specifies the flags of marker

Method Detail

getFlags

public final long getFlags()

getObject

public final java.lang.Object getObject()

copy

public Chord copy()

Description copied from class: Chord

Make a copy of this CFG node with the same out-going CFG edges. The validity of the CFG graph is maintained.

Specified by:

copy in class Chord

Returns:

a copy of this node

visit

public void visit(Predicate pred)

Description copied from class: Note

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(Note n)
   {
     ABC a = (ABC) n;
     ...
   }
 

Thus, the class that implements Predicate can call

   n.visit(this);
 

where n is a Note 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.

Specified by:

visit in class Note

See Also:

Predicate

isSpecial

public final boolean isSpecial()

Return true if this is chord was added for the convenience of the compiler and does not correspond to actual source code in the user program.

Overrides:

isSpecial in class Chord

isMarker

public final boolean isMarker()

Return true if this is a marker chord.

Overrides:

isMarker in class Chord

getDisplayColorHint

public DColor getDisplayColorHint()

Return a String specifying the color to use for coloring this node in a graphical display.

Specified by:

getDisplayColorHint in interface DisplayNode

Overrides:

getDisplayColorHint in class Chord

See Also:

DColor