Package ghidra.app.util.bin.format.pe.debug

Class DebugCOFFSymbol

  • All Implemented Interfaces:
    StructConverter
    public class DebugCOFFSymbol
extends java.lang.Object
implements StructConverter
    A class to represent the COFF symbol data structure. 
     typedef struct _IMAGE_SYMBOL {
     union {
         BYTE    ShortName[8];
         struct {
             DWORD   Short;     // if 0, use LongName
             DWORD   Long;      // offset into string table
         } Name;
         DWORD   LongName[2];    // PBYTE [2]
     } N;
     DWORD   Value;
     SHORT   SectionNumber;
     WORD    Type;
     BYTE    StorageClass;
     BYTE    NumberOfAuxSymbols;
 } IMAGE_SYMBOL;

    • Constructor Detail

      • DebugCOFFSymbol

        public DebugCOFFSymbol()
        DO NOT USE THIS CONSTRUCTOR, USE create*(GenericFactory ...) FACTORY METHODS INSTEAD.

    • Method Detail

      • getAuxiliarySymbols

        public DebugCOFFSymbolAux[] getAuxiliarySymbols()
        Returns the auxiliary symbols related to this symbol.
        Returns:
        the auxiliary symbols related to this symbol

      • getName

        public java.lang.String getName()
        Returns the name of this symbol.
        Returns:
        the name of this symbol

      • getValue

        public int getValue()
        Returns the value of this symbol.
        Returns:
        the value of this symbol

      • getValueAsString

        public java.lang.String getValueAsString()
        Returns a string equivalent of the value of this symbol.
        Returns:
        a string equivalent of the value of this symbol

      • getSectionNumber

        public int getSectionNumber()
        Returns the section number if this symbol.
        Returns:
        the section number if this symbol

      • getSectionNumberAsString

        public java.lang.String getSectionNumberAsString()
        Returns a string equivalent of the section number of this symbol.
        Returns:
        a string equivalent of the section number of this symbol

      • getType

        public int getType()
        Returns the type of this symbol.
        Returns:
        the type of this symbol

      • getTypeAsString

        public java.lang.String getTypeAsString()
        Returns a string equivalent of the type of this symbol.
        Returns:
        a string equivalent of the type of this symbol

      • getStorageClass

        public int getStorageClass()
        Returns the storage class of this symbol.
        Returns:
        the storage class of this symbol

      • getStorageClassAsString

        public java.lang.String getStorageClassAsString()
        Returns a string equivalent of the storage class of this symbol.
        Returns:
        a string equivalent of the storage class of this symbol

      • getNumberOfAuxSymbols

        public int getNumberOfAuxSymbols()
        Returns the number of auxiliary symbols defined with this symbol.
        Returns:
        the number of auxiliary symbols defined with this symbol

      • toDataType

        public DataType toDataType()
                    throws DuplicateNameException,
                           java.io.IOException
        Description copied from interface: StructConverter
        Returns a structure datatype representing the contents of the implementor of this interface.

        For example, given: 

         class A {
     int foo;
     double bar;
 }

        The return value should be a structure data type with two data type components; an INT and a DOUBLE. The structure should contain field names and, if possible, field comments.

        Specified by:
        toDataType in interface StructConverter
        Returns:
        returns a structure datatype representing the implementor of this interface
        Throws:
        DuplicateNameException - when a datatype of the same name already exists
        java.io.IOException
        See Also:
        StructureDataType