SymbolTable (WALA Core 1.3.8 API)

java.lang.Object
- com.ibm.wala.ssa.SymbolTable

All Implemented Interfaces:

Cloneable
```
public class SymbolTable
extends Object
implements Cloneable
```
A symbol table which associates information with each variable (value number) in an SSA IR. By convention, symbol numbers start at 1 ... the "this" parameter will be symbol number 1 in a virtual method. This class is used heavily during SSA construction by SSABuilder.

Constructor Summary

Constructors
Constructor and Description

SymbolTable(int numberOfParameters)

Constructors
Constructor and Description
`SymbolTable(int numberOfParameters)`

Method Summary

Methods
Modifier and Type	Method and Description
`SymbolTable`	`copy()`
`void`	`ensureSymbol(int i)` ensure that the symbol table has allocated space for the particular value number
`int`	`getConstant(boolean b)`
`int`	`getConstant(double d)`
`int`	`getConstant(float f)`
`int`	`getConstant(int i)`
`int`	`getConstant(long l)`
`int`	`getConstant(String s)`
`Object`	`getConstantValue(int v)`
`int`	`getDefaultValue(int vn)`
`double`	`getDoubleValue(int v)`
`float`	`getFloatValue(int v)`
`int`	`getIntValue(int v)`
`long`	`getLongValue(int v)`
`int`	`getMaxValueNumber()`
`int`	`getNullConstant()`
`int`	`getNumberOfParameters()`
`int`	`getParameter(int i)` Return the value number of the ith parameter By convention, for a non-static method, the 0th parameter is 'this'
`int[]`	`getParameterValueNumbers()`
`PhiValue`	`getPhiValue(int valueNumber)` Return the PhiValue that is associated with a given value number
`String`	`getStringValue(int v)`
`Value`	`getValue(int valueNumber)`
`String`	`getValueString(int valueNumber)`
`boolean`	`isBooleanConstant(int v)`
`boolean`	`isBooleanOrZeroOneConstant(int v)`
`boolean`	`isConstant(int v)`
`boolean`	`isDoubleConstant(int v)`
`boolean`	`isFalse(int v)`
`boolean`	`isFloatConstant(int v)`
`boolean`	`isIntegerConstant(int v)`
`boolean`	`isLongConstant(int v)`
`boolean`	`isNullConstant(int v)`
`boolean`	`isNumberConstant(int v)`
`boolean`	`isOne(int v)`
`boolean`	`isOneOrTrue(int v)`
`boolean`	`isParameter(int valueNumber)`
`boolean`	`isStringConstant(int v)`
`boolean`	`isTrue(int v)`
`boolean`	`isZero(int v)`
`boolean`	`isZeroOrFalse(int v)`
`int`	`newPhi(int[] rhs)`
`int`	`newSymbol()` Method newSymbol.
`void`	`setConstantValue(int vn, ConstantValue val)`
`void`	`setDefaultValue(int vn, Object defaultValue)` Set the default value for a value number.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SymbolTable
```
public SymbolTable(int numberOfParameters)
```
  Parameters:
  numberOfParameters - in the IR .. should be ir.getNumberOfParameters()

Method Detail

newSymbol
```
public int newSymbol()
```
Method newSymbol.

Returns:
int

setConstantValue

public void setConstantValue(int vn,
                    ConstantValue val)

setDefaultValue
```
public void setDefaultValue(int vn,
                   Object defaultValue)
```
Set the default value for a value number. The notion of a default value is for use by languages that do not require variables to be defined before they are used. In this situation, SSA conversion can fail since it depends on the assumption that values are always defined when used. The default value is the constant to be used in cases when a given value is used without having been defined. Currently, this is used only by CAst front ends for languages with this "feature".

getDefaultValue
```
public int getDefaultValue(int vn)
```

getNullConstant
```
public int getNullConstant()
```

getConstant
```
public int getConstant(boolean b)
```

getConstant
```
public int getConstant(int i)
```

getConstant
```
public int getConstant(long l)
```

getConstant
```
public int getConstant(float f)
```

getConstant
```
public int getConstant(double d)
```

getConstant
```
public int getConstant(String s)
```

getParameter
```
public int getParameter(int i)
                 throws IllegalArgumentException
```
Return the value number of the ith parameter By convention, for a non-static method, the 0th parameter is 'this'

Throws:

IllegalArgumentException

ensureSymbol
```
public void ensureSymbol(int i)
```
ensure that the symbol table has allocated space for the particular value number

Parameters:
i - a value number

getValueString

public String getValueString(int valueNumber)

isConstant
```
public boolean isConstant(int v)
```

isZero
```
public boolean isZero(int v)
```

isOne
```
public boolean isOne(int v)
```

isTrue
```
public boolean isTrue(int v)
```

isZeroOrFalse
```
public boolean isZeroOrFalse(int v)
```

isOneOrTrue
```
public boolean isOneOrTrue(int v)
```

isFalse
```
public boolean isFalse(int v)
```

isBooleanOrZeroOneConstant

public boolean isBooleanOrZeroOneConstant(int v)

isBooleanConstant

public boolean isBooleanConstant(int v)

isIntegerConstant

public boolean isIntegerConstant(int v)

isLongConstant
```
public boolean isLongConstant(int v)
```

isFloatConstant

public boolean isFloatConstant(int v)

isDoubleConstant

public boolean isDoubleConstant(int v)

isNumberConstant

public boolean isNumberConstant(int v)

isStringConstant

public boolean isStringConstant(int v)

isNullConstant
```
public boolean isNullConstant(int v)
```

newPhi

public int newPhi(int[] rhs)
           throws IllegalArgumentException

Throws:: IllegalArgumentException - if rhs is null

getPhiValue
```
public PhiValue getPhiValue(int valueNumber)
```
Return the PhiValue that is associated with a given value number

getMaxValueNumber
```
public int getMaxValueNumber()
```

getParameterValueNumbers

public int[] getParameterValueNumbers()

getNumberOfParameters
```
public int getNumberOfParameters()
```

getStringValue

public String getStringValue(int v)
                      throws IllegalArgumentException

Throws:: IllegalArgumentException

getFloatValue

public float getFloatValue(int v)
                    throws IllegalArgumentException

Throws:: IllegalArgumentException

getDoubleValue

public double getDoubleValue(int v)
                      throws IllegalArgumentException

Throws:: IllegalArgumentException

getIntValue

public int getIntValue(int v)
                throws IllegalArgumentException

Throws:: IllegalArgumentException

getLongValue

public long getLongValue(int v)
                  throws IllegalArgumentException

Throws:: IllegalArgumentException

getConstantValue

public Object getConstantValue(int v)
                        throws IllegalArgumentException

Throws:: IllegalArgumentException

getValue
```
public Value getValue(int valueNumber)
```
Returns:
the Value object for given value number or null if we have no special information about the value

isParameter
```
public boolean isParameter(int valueNumber)
```
Parameters:
valueNumber -

Returns:
true iff this valueNumber is a parameter

copy
```
public SymbolTable copy()
```

Class SymbolTable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SymbolTable

Method Detail

newSymbol

setConstantValue

setDefaultValue

getDefaultValue

getNullConstant

getConstant

getConstant

getConstant

getConstant

getConstant

getConstant

getParameter

ensureSymbol

getValueString

isConstant

isZero

isOne

isTrue

isZeroOrFalse

isOneOrTrue

isFalse

isBooleanOrZeroOneConstant

isBooleanConstant

isIntegerConstant

isLongConstant

isFloatConstant

isDoubleConstant

isNumberConstant

isStringConstant

isNullConstant

newPhi

getPhiValue

getMaxValueNumber

getParameterValueNumbers

getNumberOfParameters

getStringValue

getFloatValue

getDoubleValue

getIntValue

getLongValue

getConstantValue

getValue

isParameter

copy