|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object scale.common.Root scale.clef.Node scale.clef.decl.Declaration scale.clef.decl.ValueDecl scale.clef.decl.VariableDecl scale.clef.decl.FormalDecl
public class FormalDecl
This class represents a formal parameter to a procedure/function.
$Id: FormalDecl.java,v 1.43 2007-03-21 13:31:51 burrill Exp $
Copyright 2007 by the Scale Compiler Group,
Department of Computer Science
University of Massachusetts,
Amherst MA. 01003, USA
All Rights Reserved.
Field Summary |
---|
Fields inherited from class scale.clef.decl.VariableDecl |
---|
ignoreAddressTaken |
Constructor Summary | |
---|---|
FormalDecl(java.lang.String name,
Type type)
|
|
FormalDecl(java.lang.String name,
Type type,
ParameterMode passByMode)
|
|
FormalDecl(java.lang.String name,
Type type,
ParameterMode passByMode,
Expression defaultValue)
|
Method Summary | |
---|---|
Declaration |
copy(java.lang.String name)
Return a copy of this Declaration but with a different name. |
Literal |
getConstantValue()
Return the constant value of the expression. |
Expression |
getDefaultValue()
Return the default value for this parameter (unused). |
ParameterMode |
getMode()
Return the parameter passing mode. |
boolean |
isFormalDecl()
Return true if this variable is an argument to the routine. |
FormalDecl |
returnFormalDecl()
Re a FormalDecl instance or null . |
protected void |
setDefaultValue(Expression d)
Set the default value for this parameter (unused). |
void |
setMode(ParameterMode passByMode)
Specify the parameter passing mode. |
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.decl.ValueDecl |
---|
getChild, getValue, isValueDecl, numChildren, returnValueDecl |
Methods inherited from class scale.clef.Node |
---|
getSourceLineNumber, setAnnotationLevel, setReportLevel, setSourceLineNumber, toString, toString, toStringChildren |
Methods inherited from class scale.common.Root |
---|
addAnnotation, allAnnotations, allMatchingAnnotations, getAnnotation, getDisplayName, getDisplayString, getNodeCount, getNodeID, hasAnnotation, hasEqualAnnotation, 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 |
---|
public FormalDecl(java.lang.String name, Type type, ParameterMode passByMode, Expression defaultValue)
public FormalDecl(java.lang.String name, Type type, ParameterMode passByMode)
public FormalDecl(java.lang.String name, Type type)
Method Detail |
---|
public java.lang.String toStringSpecial()
Node
toStringSpecial
in class VariableDecl
public void visit(Predicate p)
Node
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.
visit
in class VariableDecl
Predicate
public final ParameterMode getMode()
getMode
in class Declaration
ParameterMode
public final Expression getDefaultValue()
public final void setMode(ParameterMode passByMode)
protected final void setDefaultValue(Expression d)
public Literal getConstantValue()
getConstantValue
in class VariableDecl
Lattice
public Declaration copy(java.lang.String name)
copy
in class VariableDecl
public final boolean isFormalDecl()
isFormalDecl
in class Declaration
public final FormalDecl returnFormalDecl()
Declaration
FormalDecl
instance or null
.
returnFormalDecl
in class Declaration
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |