Package ghidra.app.util.bin.format.som

Class SomAuxId

java.lang.Object
ghidra.app.util.bin.format.som.SomAuxId
All Implemented Interfaces:
StructConverter
public class SomAuxId extends Object implements StructConverter
Represents a SOM aux_id structure
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    SIZE
    The size in bytes of a SomAuxId

    Fields inherited from interface ghidra.app.util.bin.StructConverter

    ASCII, BYTE, DWORD, IBO32, IBO64, POINTER, QWORD, SLEB128, STRING, ULEB128, UTF16, UTF8, VOID, WORD

  • Constructor Summary

    Constructors
    Constructor
    Description
    SomAuxId(BinaryReader reader)
    Creates a new SomAuxId

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAppend()
    Returns whether or not this auxiliary header is to be copied without modification to any new SOM created from this SOM, except that multiple entries with the same type and append set of “action flags” (i.e., mandatory, copy, append, ignore) should be merged (concatenation of the data portion).
    boolean
    getCopy()
    Returns whether or not this auxiliary header is to be copied without modification to any new SOM created from this SOM.
    boolean
    getIgnore()
    Returns whether or not this auxiliary header should be ignored if its type field is unknown (i.e., do not copy, do not merge).
    long
    getLength()
    Returns the length of the auxiliary header in bytes (this value does NOT include the two word identifiers at the front of the header).
    boolean
    getMandatory()
    Returns whether or not this auxiliary header contains information that the linker must understand.
    int
    getReserved()
    Returns the reserved value.
    int
    getType()
    Returns the type of auxiliary header.
    DataType
    toDataType()
    Returns a structure datatype representing the contents of the implementor of this interface.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

  • Method Details

    • getMandatory

      public boolean getMandatory()
      Returns whether or not this auxiliary header contains information that the linker must understand.
      Returns:
      whether or not this auxiliary header contains information that the linker must understand

    • getCopy

      public boolean getCopy()
      Returns whether or not this auxiliary header is to be copied without modification to any new SOM created from this SOM.
      Returns:
      whether or not this auxiliary header is to be copied without modification to any new SOM created from this SOM

    • getAppend

      public boolean getAppend()
      Returns whether or not this auxiliary header is to be copied without modification to any new SOM created from this SOM, except that multiple entries with the same type and append set of “action flags” (i.e., mandatory, copy, append, ignore) should be merged (concatenation of the data portion).
      Returns:
      whether or not this auxiliary header is to be copied without modification to any new SOM created from this SOM, except that multiple entries with the same type and append set of “action flags” (i.e., mandatory, copy, append, ignore) should be merged (concatenation of the data portion)

    • getIgnore

      public boolean getIgnore()
      Returns whether or not this auxiliary header should be ignored if its type field is unknown (i.e., do not copy, do not merge).
      Returns:
      whether or not this auxiliary header should be ignored if its type field is unknown (i.e., do not copy, do not merge)

    • getReserved

      public int getReserved()
      Returns the reserved value.
      Returns:
      the reserved value

    • getType

      public int getType()
      Returns the type of auxiliary header.
      Returns:
      the type of auxiliary header
      See Also:

    • getLength

      public long getLength()
      Returns the length of the auxiliary header in bytes (this value does NOT include the two word identifiers at the front of the header).
      Returns:
      the length of the auxiliary header in bytes (this value does NOT include the two word identifiers at the front of the header)

    • toDataType

      public DataType toDataType() throws DuplicateNameException, 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
      IOException - if an IO-related error occurs
      See Also: