Package ghidra.program.database.symbol
Class FunctionSymbol
java.lang.Object
ghidra.program.database.DatabaseObject
ghidra.program.database.symbol.SymbolDB
ghidra.program.database.symbol.FunctionSymbol
- All Implemented Interfaces:
Symbol
Symbol class for functions.
Symbol Data Usage:
EXTERNAL:
String stringData - external memory address/label
-
Field Summary
Fields inherited from class ghidra.program.database.DatabaseObject
key
-
Constructor Summary
ConstructorDescriptionFunctionSymbol
(SymbolManager symbolMgr, DBObjectCache<SymbolDB> cache, Address address, DBRecord record) Construct a new FunctionSymbol -
Method Summary
Modifier and TypeMethodDescriptionboolean
delete()
Delete the symbol and its associated resources.protected String
The code for creating the name content for this symbol.protected Namespace
int
getReferences
(TaskMonitor monitor) Returns all memory references to the address of this symbol.Returns this symbol's typeboolean
boolean
boolean
Returns true if this an external symbol.boolean
isPinned()
Returns true if the symbol is pinned to its current address.boolean
boolean
isValidParent
(Namespace parent) Determines if the given parent is valid for this Symbol.void
setNameAndNamespace
(String newName, Namespace newNamespace, SourceType source) Sets the symbols name and namespace.void
setPinned
(boolean pinned) Sets whether or not this symbol is pinned to its associated address.protected SourceType
validateNameSource
(String newName, SourceType source) Allow symbol implementations to validate the source when setting the name of this symbolMethods inherited from class ghidra.program.database.symbol.SymbolDB
checkDeleted, doCheckIsPrimary, doIsPinned, doSetNameAndNamespace, doSetPinned, doSetPrimary, equals, getAddress, getDataTypeId, getID, getName, getName, getParentNamespace, getParentSymbol, getPath, getProgram, getReferences, getSource, getSymbolStringData, getVariableOffset, hashCode, isDeleted, isDeleting, isDescendant, isDynamic, isExternalEntryPoint, isGlobal, moveLowLevel, refresh, refresh, setAddress, setDataTypeId, setName, setNamespace, setPrimary, setSource, setSymbolStringData, setVariableOffset, toString
Methods inherited from class ghidra.program.database.DatabaseObject
checkIsValid, checkIsValid, getKey, isDeleted, isInvalid, keyChanged, setDeleted, setInvalid, validate
-
Constructor Details
-
FunctionSymbol
public FunctionSymbol(SymbolManager symbolMgr, DBObjectCache<SymbolDB> cache, Address address, DBRecord record) Construct a new FunctionSymbol- Parameters:
symbolMgr
- the symbol manager.cache
- symbol object cacheaddress
- the address for this symbol.record
- the record for this symbol.
-
-
Method Details
-
getSymbolType
Description copied from interface:Symbol
Returns this symbol's type- Returns:
- symbol type
- See Also:
-
isExternal
public boolean isExternal()Description copied from interface:Symbol
Returns true if this an external symbol.- Returns:
- true if this an external symbol.
- See Also:
-
setNameAndNamespace
public void setNameAndNamespace(String newName, Namespace newNamespace, SourceType source) throws DuplicateNameException, InvalidInputException, CircularDependencyException Description copied from interface:Symbol
Sets the symbols name and namespace. This is provided to allow the caller to avoid a name conflict by creating an autonomous action.- Specified by:
setNameAndNamespace
in interfaceSymbol
- Overrides:
setNameAndNamespace
in classSymbolDB
- Parameters:
newName
- new symbol namenewNamespace
- new parent namespacesource
- the source of this symbol
Some symbol types, such as function symbols, can set the source to Symbol.DEFAULT.- Throws:
DuplicateNameException
- if newNamespace already contains a symbol with this symbol's nameInvalidInputException
- is newNamespace is not a valid parent for this symbolCircularDependencyException
- if this symbol is an ancestor of newNamespace
-
delete
public boolean delete()Description copied from interface:Symbol
Delete the symbol and its associated resources. Any references symbol associations will be discarded. -
getObject
- Returns:
- object associated with this symbol or null if symbol has been deleted
-
isPrimary
public boolean isPrimary() -
isPinned
public boolean isPinned()Description copied from interface:Symbol
Returns true if the symbol is pinned to its current address. If it is pinned, then moving or removing the memory associated with that address will not affect this symbol. -
setPinned
public void setPinned(boolean pinned) Description copied from interface:Symbol
Sets whether or not this symbol is pinned to its associated address.
If the symbol is pinned then moving or removing the memory associated with its address will not cause this symbol to be removed and will not cause its address to change. If the symbol is not pinned, then removing the memory at its address will also remove this symbol.
Likewise, moving a memory block containing a symbol that is not anchored will change the address for that symbol to keep it associated with the same byte in the memory block.
-
getProgramLocation
- Returns:
- a program location corresponding to this symbol
-
isValidParent
Description copied from interface:Symbol
Determines if the given parent is valid for this Symbol. Specified namespace must belong to the same symbol table as this symbol.- Specified by:
isValidParent
in interfaceSymbol
- Overrides:
isValidParent
in classSymbolDB
- Parameters:
parent
- prospective parent namespace for this symbol- Returns:
- true if parent is valid
-
doGetName
Description copied from class:SymbolDB
The code for creating the name content for this symbol. This code will be called with the symbol's lock. -
doGetParentNamespace
- Overrides:
doGetParentNamespace
in classSymbolDB
-
validateNameSource
Description copied from class:SymbolDB
Allow symbol implementations to validate the source when setting the name of this symbol- Overrides:
validateNameSource
in classSymbolDB
- Parameters:
newName
- the new namesource
- the source type- Returns:
- the validated source type
-
getSymbolsDynamicallyRenamedByMyRename
- Overrides:
getSymbolsDynamicallyRenamedByMyRename
in classSymbolDB
-
getReferences
Description copied from interface:Symbol
Returns all memory references to the address of this symbol. If you do not have aTaskMonitor
instance, then you can passTaskMonitor.DUMMY
ornull
.- Specified by:
getReferences
in interfaceSymbol
- Overrides:
getReferences
in classSymbolDB
- Parameters:
monitor
- the monitor that is used to report progress and to cancel this potentially long-running call- Returns:
- all memory references to the address of this symbol.
-
getReferenceCount
public int getReferenceCount()- Specified by:
getReferenceCount
in interfaceSymbol
- Overrides:
getReferenceCount
in classSymbolDB
- Returns:
- the number of References to this symbol.
-
hasMultipleReferences
public boolean hasMultipleReferences()- Specified by:
hasMultipleReferences
in interfaceSymbol
- Overrides:
hasMultipleReferences
in classSymbolDB
- Returns:
- true if this symbol has more than one reference to it.
-
hasReferences
public boolean hasReferences()- Specified by:
hasReferences
in interfaceSymbol
- Overrides:
hasReferences
in classSymbolDB
- Returns:
- true if this symbol has at least one reference to it.
-