All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.arcsinc.hardwarehost.coff.SymTableFilter 

java.lang.Object
   |
   +----com.arcsinc.hardwarehost.coff.SymTableFilter
public class SymTableFilter
extends Object
The SymTableFilter class provides a filtered view of the symbols for the application loaded in the CoffHandler. This class also provides a mechanism to exclude modules from the available list. For example, all standard dsp applications have a module exit.asm. This module is of little value to view so it may be placed on the excluded list.

See Also:
CoffHandler

Constructor Index

o SymTableFilter(CoffHandler)
Instantiates the SymTableFilter.

Method Index

o clearModuleExclusions()
Clear the value of moduleExclusions. eExclusions.
o getAvailableModules()
This function provides an array of modules which are available.
o getAvailableVariables(String)
This function provides an array of symbol names from the
o getFileVariableSpace(String, String)
Determines the starting address and range for the file scope variables in the module
o getFileVariableSpaceOld(String)
Determines the starting address and range for the file scope variables in the module
o getModuleExclusions()
Get the value of moduleExclusions.
o getSymbolBasicType(String, String)
Finds the symbol's basic type (void, int, float, etc.) using its
o getSymbolDerivedType(String, String)
Finds the symbol's derived type (none, pointer, etc.) using its
o getSymbolLocation(String, String)
Finds the symbol's address using its
o getUseModuleExclusions()
Get the value of useExclusions.
o isModuleExcluded(String)
Determine whether or not a particular module is excluded.
o isSymbolArray(String, String)
Determines whether or not this symbol is of array (DT_ARY) type.
o isSymbolPointer(String, String)
Determines whether or not this symbol is of pointer (DT_PTR) type.
o setModuleExclusions(String[])
Set the value of moduleExclusions.
o setUseModuleExclusions(boolean)
Set the value of useModuleExclusions.

Constructors

o SymTableFilter 
 public SymTableFilter(CoffHandler coffHandler)
Instantiates the SymTableFilter.

Parameters:
coffHandler - reference the coffHandler which will be used.

Methods

o getUseModuleExclusions 
 public boolean getUseModuleExclusions()
Get the value of useExclusions.

Returns:
Value of useExclusions.
o setUseModuleExclusions 
 public void setUseModuleExclusions(boolean v)
Set the value of useModuleExclusions. If true, the modules identified by a call to setModuleExlusions will NOT be available.

Parameters:
v - Value to assign to useModuleExclusions.
o getModuleExclusions 
 public String[] getModuleExclusions()
Get the value of moduleExclusions.

Returns:
Value of moduleExclusions.
o setModuleExclusions 
 public void setModuleExclusions(String v[])
Set the value of moduleExclusions.

Parameters:
v - Value to assign to moduleExclusions.
oges/red-ball.gif clearModuleExclusions 
 public void clearModuleExclusions()
Clear the value of moduleExclusions.

o isModuleExcluded 
 public boolean isModuleExcluded(String module)
Determine whether or not a particular module is excluded.

Returns:
true if excluded, otherwise false.
o getAvailableModules 
 public String[] getAvailableModules()
This function provides an array of modules which are available.

Returns:
a String array with the application modules.
o getAvailableVariables 
 public String[] getAvailableVariables(String module)
This function provides an array of symbol names from the @param module which are available.

Parameters:
module - name of the module
Returns:
a String array with the symbol names.
o getSymbolgetSymbolBasicType 
 public byte getSymbolBasicType(String symbolName,
                                String module)
Finds the symbol's basic type (void, int, float, etc.) using its

Parameters:
name - and @param module.
name - the symbol name (standard notation prepends "_" to the name.
module - the module name in which the symbol is defined.
Returns:
a byte representing the basic type as defined in SymbolParams
o getSymbolDerivedType 
 public byte getSymbolDerivedType(String symbolName,
                                  String module)
Finds the symbol's derived type (none, pointer, etc.) using its

Parameters:
name - and @param module.
name - the symbol name (standard notation prepends "_" to the name.
module - the module name in which the symbol is defined.
Returns:
a byte representing the derived type as defined in SymbolParams
o isSymbolArray 
 public boolean isSymbolArray(String symbolName,
                              String module)
Determines whether or not this symbol is of array (DT_ARY) type.

Parameters:
name - the symbol name (standard notation prepends "_" to the name.
module - the module name in which the symbol is defined.
Returns:
true if symbol is of array type
o isSymbolPointer 
 public boolean isSymbolPointer(String symbolName,
                                String module)
Determines whether or not this symbol is of pointer (DT_PTR) type.

Parameters:
name - the symbol name (standard notation prepends "_" to the name.
module - the module name in which the symbol is defined.
Returns:
true if symbol is of array l is of array type
o getSymbolLocation 
 public int getSymbolLocation(String symbolName,
                              String module)
Finds the symbol's address using its

Parameters:
name - and @param module.
name - the symbol name (standard notation prepends "_" to the name.
module - the module name in which the symbol is defined.
Returns:
address of the symbol.
o getFileVariableSpaceOld 
 public int[] getFileVariableSpaceOld(String module)
Determines the starting address and range for the file scope variables in the module @param module. Since there can be multiple @param module called out and some modules without .bss sections. This function is typically required for internal use. This function should not be used, instead use getFileVariableSpace()

Parameters:
module - the name of the model
Returns:
an array of int, starting address and range. int, starting address and range.
o getFileVariableSpace 
 public int[] getFileVariableSpace(String module,
                                   String sectionStr)
Determines the starting address and range for the file scope variables in the module @param module. Since there can be multiple @param module called out and some modules without .bss sections. This function is typically required fequired for internal use.

Parameters:
module - the name of the model
section - the name of the section, typically ".bss" or ".data"
Returns:
an array of int, starting address and range. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index
ody>