coins.ir.hir
Interface Exp

All Superinterfaces:

java.lang.Cloneable, HIR, HIR0, IR, IR0

All Known Subinterfaces:

ConstNode, ElemNode, ExpListExp, FunctionExp, LabelNode, NullNode, PhiExp, PointedExp, QualifiedExp, SubpNode, SubscriptedExp, SymNode, TypeNode, VarNode

All Known Implementing Classes:

ConstNodeImpl, ElemNodeImpl, ExpImpl, ExpListExpImpl, FunctionExpImpl, LabelNodeImpl, NullNodeImpl, PhiExpImpl, PointedExpImpl, QualifiedExpImpl, SubpNodeImpl, SubscriptedExpImpl, SymNodeImpl, TypeNodeImpl, VarNodeImpl

public interface Exp

extends HIR

Exp interface HIR Exp class interface. The expression class Exp is a subclass of HIR. See IR, HIR, Stmt, Sym, IrList.

Field Summary

Fields inherited from interface coins.ir.hir.HIR

OP_CODE_NAME, OP_CODE_NAME_DENSE

Fields inherited from interface coins.ir.IR

OP_INF, OP_LIST, OP_PROG, OP_SUBP_DEF

Fields inherited from interface coins.ir.hir.HIR0

FLAG_C_PTR, FLAG_CONST_EXP, FLAG_INIT_BLOCK, FLAG_LOOP_WITH_CONDITIONAL_INIT, FLAG_NOCHANGE, FLAG_NONTERMINAL, OP_ADD, OP_ADD_ASSIGN, OP_ADDR, OP_AND, OP_AND_ASSIGN, OP_ARROW, OP_ASM, OP_ASSIGN, OP_BLOCK, OP_CALL, OP_CMP_EQ, OP_CMP_GE, OP_CMP_GT, OP_CMP_LE, OP_CMP_LT, OP_CMP_NE, OP_COMMA, OP_CONST, OP_CONTENTS, OP_CONV, OP_DECAY, OP_DIV, OP_DIV_ASSIGN, OP_ELEM, OP_ENCLOSE, OP_EQ_ZERO, OP_EXP_STMT, OP_EXPLIST, OP_EXPREPEAT, OP_FOR, OP_IF, OP_INDEX, OP_INDEXED_LOOP, OP_JUMP, OP_LABEL, OP_LABEL_DEF, OP_LABELED_STMT, OP_LG_AND, OP_LG_OR, OP_MOD, OP_MOD_ASSIGN, OP_MULT, OP_MULT_ASSIGN, OP_NEG, OP_NOT, OP_NULL, OP_OFFSET, OP_OR, OP_OR_ASSIGN, OP_PARAM, OP_PHI, OP_POST_DECR, OP_POST_INCR, OP_PRE_DECR, OP_PRE_INCR, OP_QUAL, OP_REPEAT, OP_RETURN, OP_SELECT, OP_SEQ, OP_SETDATA, OP_SHIFT_L_ASSIGN, OP_SHIFT_LL, OP_SHIFT_R, OP_SHIFT_R_ASSIGN, OP_SHIFT_RL, OP_SIZEOF, OP_STMT, OP_STMT_UPPER, OP_SUB, OP_SUB_ASSIGN, OP_SUBP, OP_SUBS, OP_SWITCH, OP_SYM, OP_TYPE, OP_UNDECAY, OP_UNTIL, OP_VAR, OP_WHILE, OP_XOR, OP_XOR_ASSIGN

Method Summary

Exp	adjustTypesOfBinaryOperands(Exp pExp1, Exp pExp2) Adjust the types of binary operands according to the C language specifications (See ISO/IEC 9899-1999 Programming language C section 6.3.1.8).
Const	evaluate() Evaluate "this" expression.
double	evaluateAsDouble() evaluateAsDouble Evaluate "this" expression as double.
float	evaluateAsFloat() evaluateAsFloat Evaluate "this" expression as float.
int	evaluateAsInt() evaluateAsInt Evaluate "this" expression as int.
long	evaluateAsLong() Evaluate "this" expression as long.
SubpType	findSubpType() findSubpType Find SubpType represented by this expression.
Exp	fold() Fold "this" expression.
IrList	getActualParamList()
Exp	getArrayExp() getArrayExp (##2) getSubscriptExp getElemSizeExp (##2) Get a component of a subscripted variable.
Const	getConstSym() getConstSym Get constant symbol attached to this node.
Elem	getElem() getElem Get symbol of spefified class from SymNode.
Exp	getElemSizeExp()
Exp	getExp1() getExp1 Get source operand 1 from unary or binary expression.
Exp	getExp2() getExp2 Get source operand 2 from binary expression.
Label	getLabel() getLabel Get symbol of spefified class from SymNode.
Elem	getPointedElem()
Exp	getPointerExp() getPointerExp getPointedElem Get a component of pointed variable expression.
Elem	getQualifiedElem()
Exp	getQualifierExp() getQualifier getQualifiedElem Get a component of qualified variable expression.
Subp	getSubp() getSubp Get symbol of spefified class from SymNode.
Exp	getSubpSpec() getSubpSpec (##2) getActualParamList Get a component expression of the function expression.
Exp	getSubscriptExp()
java.lang.String	getValueString() getValueString //##40 Evaluate this subtree and return the result as a string.
Var	getVar() getVar Get symbol of specified class from SymNode.
Stmt	initiateArray(Exp pArray, Exp pInitExp, Exp pFrom, Exp pTo, Subp pSubp) initiateArray //##15 Create loop statement to initiate all elements of the array pArray and append it to the initiation block of subprogram pSubp.
boolean	isEvaluable() isEvaluable See if "this" expression can be evaluated or not.

Methods inherited from interface coins.ir.hir.HIR

addrExp, asmStmt, checkLinkage, conditionalExp, contains, copyInfListFrom, cutParentLink, exp, expList, expRepeat, forStmt, getExpId, getFlowAnalSym, getIndentSpace, getInfString, getIrName, getSourceNode, getSourceNode1, getSourceNode2, getSymOrExpId, getWork, hirNodeClone, hirSeq, hirSeq, indexedLoopStmt, indexedLoopStmt, infStmt, infStmt, intConstNode, irList, isEmpty, isStmt, isTree, nullNode, nullStmt, offsetConstNode, phiExp, repeatStmt, replaceSource, replaceSource1, replaceSource2, returnStmt, setChild1, setChild2, setChildren, setChildren, setDataStmt, setIndex, setIndexNumberToAllNodes, setParent, setType, setWork, subpDefinition, subpIterator, subscriptedExp, toString, toStringDetail, toStringShort, toStringWithChildren, undecayExp, undecayExp, undecayExp, whileStmt

Methods inherited from interface coins.ir.IR

addInf, getChild1, getChild2, getInf, getInfList, getParent, getSym, print, print, removeInf

Methods inherited from interface coins.ir.IR0

getChild, getChildCount, getIndex, getOperator, setChild

Methods inherited from interface coins.ir.hir.HIR0

accept, assignStmt, blockStmt, callStmt, constNode, contentsExp, convExp, copyWithOperands, copyWithOperandsChangingLabels, decayExp, elemNode, exp, exp, expStmt, falseNode, finishHir, forStmt, functionExp, getChildNumber, getFlag, getFlagBox, getNextStmt, getStmtContainingThisNode, getType, hirClone, hirIterator, hirList, hirSeq, ifStmt, intConstNode, irList, isSameAs, jumpStmt, labelDef, labeledStmt, labelNode, pointedExp, print, program, qualifiedExp, repeatStmt, replaceThisNode, returnStmt, setFlag, setIndexNumberToAllNodes, sizeofExp, sizeofExp, subpDefinition, subpNode, subscriptedExp, switchStmt, symNode, trueNode, undecayExp, varNode, whileStmt

Method Detail

getConstSym

public Const getConstSym()

getConstSym Get constant symbol attached to this node. "this" should be a constant node.

Returns:

constant symbol attached to this node.

getVar

public Var getVar()

getVar Get symbol of specified class from SymNode. (##2) "this" should be a SymNode.

Returns:

the symbol of specified class attached to the node. If the symbol is not attached to the node or if its class is not the specified class, then return null.

getSubp

public Subp getSubp()

getSubp Get symbol of spefified class from SymNode. (##2) "this" should be a SymNode.

Returns:

the symbol of specified class attached to the node. If the symbol is not attached to the node or if its class is not the specified class, then return null.

getLabel

public Label getLabel()

getLabel Get symbol of spefified class from SymNode. (##2) "this" should be a SymNode.

Returns:

the symbol of specified class attached to the node. If the symbol is not attached to the node or if its class is not the specified class, then return null.

getElem

public Elem getElem()

getElem Get symbol of spefified class from SymNode. (##2) "this" should be a SymNode.

Returns:

the symbol of specified class attached to the node. If the symbol is not attached to the node or if its class is not the specified class, then return null.

getExp1

public Exp getExp1()

getExp1 Get source operand 1 from unary or binary expression. "this" should be either unary or binary expression.

Returns:

the source operand 1 expression of this node.

getExp2

public Exp getExp2()

getExp2 Get source operand 2 from binary expression. "this" should be a binary expression.

Returns:

the source operand 2 expression of this node.

getArrayExp

public Exp getArrayExp()

getArrayExp (##2) getSubscriptExp getElemSizeExp (##2) Get a component of a subscripted variable. "this" should be a node built by buildSubscriptedVar method.

Returns:

a component expression of this subscripted variable.

getSubscriptExp

public Exp getSubscriptExp()

getElemSizeExp

public Exp getElemSizeExp()

getPointerExp

public Exp getPointerExp()

getPointerExp getPointedElem Get a component of pointed variable expression. "this" should be a node built by buildPointedVar method.

Returns:

a component expression of this pointed variable.

getPointedElem

public Elem getPointedElem()

getQualifierExp

public Exp getQualifierExp()

getQualifier getQualifiedElem Get a component of qualified variable expression. "this" should be a node built by BuildQualifiedVar method.

Returns:

a component of "this" QualifiedVar expression. (##2)

getQualifiedElem

public Elem getQualifiedElem()

getSubpSpec

public Exp getSubpSpec()

getSubpSpec (##2) getActualParamList Get a component expression of the function expression. (##2) "this" should be a node built by buildFunctionExp. getSubpSpec return the expression specifying the subprogram to be called (pSubpSpec). (##2) getActualParamList return the actual parameter list (pParamList). If this has no parameter, then return null.

getActualParamList

public IrList getActualParamList()

findSubpType

public SubpType findSubpType()

findSubpType Find SubpType represented by this expression. If this is SubpNode then return SubpType pointed by this node type, else decompose this expression to find Subpnode. If illegal type is encountered, return null.

isEvaluable

public boolean isEvaluable()

isEvaluable See if "this" expression can be evaluated or not. Following expressions are evaluable expression: //##14 constant expression, expression whose operands are all evaluable expressions. Expressions with OP_ADDR or OP_NULL are treated as non evaluable. Variable with initial value is also treated as non evaluable because its value may change. //##43

Returns:

true if this expression can be evaluated as constant value at the invocation of this method, false otherwise.

evaluate

public Const evaluate()

Evaluate "this" expression.

Returns:

constant as the result of evaluation or null(when failing in the evaluation)

fold

public Exp fold()

Fold "this" expression. evaluate() is called by recursive. If the evaluation succeeded, former node is substituted for the constant node generated as evaluation result.

Returns:

constant as the result of evaluation or null (when failing in the evaluation)

evaluateAsInt

public int evaluateAsInt()

evaluateAsInt Evaluate "this" expression as int. "this" should be an evaluable expression. If not, this method returns 0. It is strongly recommended to confirm isEvaluable() returns true for this expression before calling this method.

Returns:

integer value as the result of evaluation.

evaluateAsLong

public long evaluateAsLong()

Evaluate "this" expression as long. "this" should be an evaluable expression. If not, this method returns 0.

Returns:

long value as the result of evaluation.

evaluateAsFloat

public float evaluateAsFloat()

evaluateAsFloat Evaluate "this" expression as float. "this" should be an evaluable expression. If not, this method returns 0.0. It is strongly recommended to confirm isEvaluable() returns true for this expression before calling this method.

Returns:

float value as the result of evaluation.

evaluateAsDouble

public double evaluateAsDouble()

evaluateAsDouble Evaluate "this" expression as double. "this" should be an evaluable expression. If not, this method returns 0.0. It is strongly recommended to confirm isEvaluable() returns true for this expression before calling this method.

Returns:

float value as the result of evaluation.

getValueString

public java.lang.String getValueString()

getValueString //##40 Evaluate this subtree and return the result as a string. If the result is constant, then return the string representing the constant. If the result is not a constant, then return a string representing the resultant expression. It is strongly recommended to confirm isEvaluable() returns true for this expression before calling this method.

Returns:

a string representing the evaluated result.

adjustTypesOfBinaryOperands

public Exp adjustTypesOfBinaryOperands(Exp pExp1,
                                       Exp pExp2)

Adjust the types of binary operands according to the C language specifications (See ISO/IEC 9899-1999 Programming language C section 6.3.1.8). The result is an expression (HIR.OP_SEQ, adjusted_operand1, adjusted_operand2). The operands can be get by ((HIR)lResult.getChild1()).copyWithOperands() ((HIR)lResult.getChild2()).copyWithOperands()

Parameters:

pExp1 - operand 1.

pExp2 - operand 2.

Returns:

(HIR.OP_SEQ, adjusted_operand1, adjusted_operand2)

initiateArray

public Stmt initiateArray(Exp pArray,
                          Exp pInitExp,
                          Exp pFrom,
                          Exp pTo,
                          Subp pSubp)

initiateArray //##15 Create loop statement to initiate all elements of the array pArray and append it to the initiation block of subprogram pSubp. The initiation statement to be created for pSubp is for (i = pFrom; i <= pTo; i++) pArray[i] = pInitExp; If pSubp is null, set-data statement is generated.

Parameters:

pArray - array variable expression.

pInitExp - initial value to be set.

pFrom - array index start position

pTo - array index end position

pSubp - subprogram containing the initiation statement. null for global variable initiation.

Returns:

the loop statement to set initial value.