Package ghidra.program.database.symbol
Class EquateDB
java.lang.Object
ghidra.program.database.DatabaseObject
ghidra.program.database.symbol.EquateDB
- All Implemented Interfaces:
Equate
Database object for an Equate.
-
Field Summary
Fields inherited from class ghidra.program.database.DatabaseObject
key
-
Constructor Summary
ConstructorDescriptionEquateDB
(EquateManager equateMgr, DBObjectCache<EquateDB> cache, DBRecord record) Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
addReference
(long dynamicHash, Address refAddr) Add a reference (at the given dynamic hash position) to this equate.void
addReference
(Address refAddr, int opIndex) Add a reference (at the given operand position) to this equate.boolean
Gets the "display name" of this equate.Gets a more accurate representation of the equate value.Gets the universal id from this equate if the equate was based off of an enum.getName()
Get the actual name of this equate.int
Get the number of references to this equate.Get the references for this equate.getReferences
(Address refAddr) Get references for this equate attached to a specific addresslong
getValue()
Get the value of this equate.int
hashCode()
boolean
Checks if equate is based off an enum's universal id.boolean
Checks if equate is based off an enum's universal id and checks if the enum still exists.protected boolean
refresh()
Tells the object to refresh its state from the database.void
removeReference
(long dynamicHash, Address refAddr) Remove the reference at the given addressvoid
removeReference
(Address refAddr, int opIndex) Remove the reference at the given operand position.void
renameEquate
(String newName) Changes the name associated with the equate.toString()
Get the name of this equate.Methods inherited from class ghidra.program.database.DatabaseObject
checkDeleted, checkIsValid, checkIsValid, getKey, isDeleted, isInvalid, keyChanged, refresh, setDeleted, setInvalid, validate
-
Constructor Details
-
EquateDB
Constructor- Parameters:
equateMgr
- the equate managercache
- EquateDB cacherecord
- the record for this equate.
-
-
Method Details
-
refresh
protected boolean refresh()Description copied from class:DatabaseObject
Tells the object to refresh its state from the database.- Specified by:
refresh
in classDatabaseObject
- Returns:
- true if the object was able to refresh itself. Return false if the object was deleted. Objects that extend this class must implement a refresh method. If an object can never refresh itself, then it should always return false.
-
addReference
Description copied from interface:Equate
Add a reference (at the given operand position) to this equate. If a reference already exists for the instruction at this address, then the old reference will be removed before the new reference is added.- Specified by:
addReference
in interfaceEquate
- Parameters:
refAddr
- the address where the equate is used.opIndex
- the operand index where the equate is used.
-
addReference
Description copied from interface:Equate
Add a reference (at the given dynamic hash position) to this equate. If a reference already exists for the instruction at this address, then the old reference will be removed before the new reference is added.- Specified by:
addReference
in interfaceEquate
- Parameters:
dynamicHash
- constant varnode dynamic hash valuerefAddr
- the address where the equate is used.
-
getName
Description copied from interface:Equate
Get the actual name of this equate. Note that this name may be different than the "display name," which is what the user will see. -
getDisplayName
Description copied from interface:Equate
Gets the "display name" of this equate. Note that the display name may be different than the equate's actual name if the equate is based off a data type id.- Specified by:
getDisplayName
in interfaceEquate
- Returns:
- The "display name" of this equate.
-
getEnumUUID
Description copied from interface:Equate
Gets the universal id from this equate if the equate was based off of an enum.- Specified by:
getEnumUUID
in interfaceEquate
- Returns:
- The universal id for this equate.
-
getReferenceCount
public int getReferenceCount()Description copied from interface:Equate
Get the number of references to this equate.- Specified by:
getReferenceCount
in interfaceEquate
-
getReferences
Description copied from interface:Equate
Get the references for this equate.- Specified by:
getReferences
in interfaceEquate
- Returns:
- a array of EquateReferences.
-
getReferences
Description copied from interface:Equate
Get references for this equate attached to a specific address- Specified by:
getReferences
in interfaceEquate
- Parameters:
refAddr
- is the address- Returns:
- the list of EquateReferences
-
getValue
public long getValue()Description copied from interface:Equate
Get the value of this equate. -
getDisplayValue
Description copied from interface:Equate
Gets a more accurate representation of the equate value. Used for rendering as close to the listing as possible.- Specified by:
getDisplayValue
in interfaceEquate
- Returns:
- A more accurate representation of the equate value.
-
removeReference
Description copied from interface:Equate
Remove the reference at the given operand position.- Specified by:
removeReference
in interfaceEquate
- Parameters:
refAddr
- the address that was using this equateopIndex
- the operand index of the operand that was using this eqate.
-
removeReference
Description copied from interface:Equate
Remove the reference at the given address- Specified by:
removeReference
in interfaceEquate
- Parameters:
dynamicHash
- the hash of the referencerefAddr
- the reference's address
-
renameEquate
Description copied from interface:Equate
Changes the name associated with the equate.- Specified by:
renameEquate
in interfaceEquate
- Parameters:
newName
- the new name for this equate.- Throws:
DuplicateNameException
- thrown if newName is already used by another equate.InvalidInputException
- if newName contains blank characters, is zero length, or is null
-
isValidUUID
public boolean isValidUUID()Description copied from interface:Equate
Checks if equate is based off an enum's universal id and checks if the enum still exists. The equate is still valid if the equate is not based off an enum.- Specified by:
isValidUUID
in interfaceEquate
- Returns:
- true if the equate is based off an enum that still exists.
-
isEnumBased
public boolean isEnumBased()Description copied from interface:Equate
Checks if equate is based off an enum's universal id.- Specified by:
isEnumBased
in interfaceEquate
- Returns:
-
equals
-
hashCode
public int hashCode() -
toString
Description copied from interface:Equate
Get the name of this equate.
-