Package ghidra.program.database.symbol

Class CodeSymbol

java.lang.Object
ghidra.program.database.DatabaseObject
ghidra.program.database.symbol.SymbolDB
ghidra.program.database.symbol.MemorySymbol
ghidra.program.database.symbol.CodeSymbol
All Implemented Interfaces:
Symbol
public class CodeSymbol extends MemorySymbol
Symbols that represent "labels" or external data locations

  • Constructor Details

    • CodeSymbol

      public CodeSymbol(SymbolManager mgr, DBObjectCache<SymbolDB> cache, Address addr, DBRecord record)
      Constructs a new CodeSymbol
      Parameters:
      mgr - the symbol manager
      cache - symbol object cache
      addr - the address associated with the symbol
      record - the record for this symbol

    • CodeSymbol

      public CodeSymbol(SymbolManager mgr, DBObjectCache<SymbolDB> cache, Address addr, long key)
      Constructs a new CodeSymbol for a default/dynamic label.
      Parameters:
      mgr - the symbol manager
      cache - symbol object cache
      addr - the address associated with the symbol
      key - this must be the absolute encoding of addr

  • Method Details

    • getSymbolType

      public SymbolType getSymbolType()
      Description copied from interface: Symbol
      Returns this symbol's type
      Returns:
      symbol type

    • refresh

      protected boolean refresh(DBRecord rec)
      Description copied from class: DatabaseObject
      Tells the object to refresh its state from the database using the specified record if not null. NOTE: The default implementation ignores the record and invokes refresh(). Implementations of this method must take care if multiple database tables are used since the record supplied could correspond to another object. In some cases it may be best not to override this method or ignore the record provided.
      Overrides:
      refresh in class SymbolDB
      Parameters:
      rec - valid record associated with object's key (optional, may be null to force record lookup or other refresh technique)
      Returns:
      true if the object was able to refresh itself. Return false if record is null and 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.

    • delete

      public boolean delete()
      Description copied from interface: Symbol
      Delete the symbol and its associated resources. Any references symbol associations will be discarded.
      Specified by:
      delete in interface Symbol
      Overrides:
      delete in class SymbolDB
      Returns:
      true if successful

    • delete

      public boolean delete(boolean keepReferences)
      Delete code/label symbol
      Parameters:
      keepReferences - if false all references to this symbols address will be removed, otherwise associated references will simply be disassociated following symbol removal (see SymbolManager.doRemoveSymbol(SymbolDB).
      Returns:
      true if symbol successfully removed

    • getObject

      public Object getObject()
      Returns:
      object associated with this symbol or null if symbol has been deleted

    • isPrimary

      public boolean isPrimary()
      Specified by:
      isPrimary in interface Symbol
      Specified by:
      isPrimary in class SymbolDB
      Returns:
      true if this symbol is primary

    • setPrimary

      public boolean setPrimary()
      Description copied from interface: Symbol
      Sets this symbol to be primary. All other symbols at the same address will be set to !primary. Only applies to non-function symbols.
      Specified by:
      setPrimary in interface Symbol
      Overrides:
      setPrimary in class SymbolDB
      Returns:
      returns true if the symbol was not primary and now it is, otherwise false
      See Also:

    • getProgramLocation

      public ProgramLocation getProgramLocation()
      Description copied from interface: Symbol
      Returns a program location for this symbol; may be null. This allows implementations to return a more specific program location than what is typically used by the system.
      Returns:
      the location

    • isValidParent

      public boolean isValidParent(Namespace parent)
      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 interface Symbol
      Overrides:
      isValidParent in class SymbolDB
      Parameters:
      parent - prospective parent namespace for this symbol
      Returns:
      true if parent is valid

    • doGetName

      protected String 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.
      Overrides:
      doGetName in class SymbolDB
      Returns:
      the name

    • validateNameSource

      protected SourceType validateNameSource(String newName, SourceType source)
      Description copied from class: SymbolDB
      Allow symbol implementations to validate the source when setting the name of this symbol
      Overrides:
      validateNameSource in class SymbolDB
      Parameters:
      newName - the new name
      source - the source type
      Returns:
      the validated source type