Package ghidra.program.model.pcode

Class XmlEncode

java.lang.Object
ghidra.program.model.pcode.XmlEncode
All Implemented Interfaces:
CachedEncoder, Encoder
public class XmlEncode extends Object implements CachedEncoder
An XML based encoder The underlying transfer encoding is an XML document. The encoder is initialized with a StringBuilder which will receive the XML document as calls are made on the encoder.

  • Constructor Summary

    Constructors
    Constructor
    Description
    XmlEncode()
     
    XmlEncode(boolean doFormat)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clear any state associated with the encoder The encoder should be ready to write a new document after this call.
    void
    closeElement(ElementId elemId)
    End the current element in the encoding The current element must match the given annotation or an exception is thrown.
    boolean
    isEmpty()
    The encoder is considered empty if the writeTo() method would output zero bytes
    void
    openElement(ElementId elemId)
    Begin a new element in the encoding The element will have the given ElementId annotation and becomes the \e current element.
    String
    toString()
     
    void
    writeBool(AttributeId attribId, boolean val)
    Write an annotated boolean value into the encoding The boolean data is associated with the given AttributeId annotation and the current open element.
    void
    writeOpcode(AttributeId attribId, int opcode)
    Write a p-code operation opcode into the encoding, associating it with the given annotation.
    void
    writeSignedInteger(AttributeId attribId, long val)
    Write an annotated signed integer value into the encoding The integer is associated with the given AttributeId annotation and the current open element.
    void
    writeSpace(AttributeId attribId, int index, String name)
    Write an address space reference into the encoding.
    void
    writeSpace(AttributeId attribId, AddressSpace spc)
    Write an address space reference into the encoding The address space is associated with the given AttributeId annotation and the current open element.
    void
    writeString(AttributeId attribId, String val)
    Write an annotated string into the encoding The string is associated with the given AttributeId annotation and the current open element.
    void
    writeStringIndexed(AttributeId attribId, int index, String val)
    Write an annotated string, using an indexed attribute, into the encoding.
    void
    writeTo(OutputStream stream)
    Dump all the accumulated bytes in this encoder to the stream.
    void
    writeUnsignedInteger(AttributeId attribId, long val)
    Write an annotated unsigned integer value into the encoding The integer is associated with the given AttributeId annotation and the current open element.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • XmlEncode

      public XmlEncode()

    • XmlEncode

      public XmlEncode(boolean doFormat)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • clear

      public void clear()
      Description copied from interface: CachedEncoder
      Clear any state associated with the encoder The encoder should be ready to write a new document after this call.
      Specified by:
      clear in interface CachedEncoder

    • openElement

      public void openElement(ElementId elemId) throws IOException
      Description copied from interface: Encoder
      Begin a new element in the encoding The element will have the given ElementId annotation and becomes the \e current element.
      Specified by:
      openElement in interface Encoder
      Parameters:
      elemId - is the given ElementId annotation
      Throws:
      IOException - for errors in the underlying stream

    • closeElement

      public void closeElement(ElementId elemId) throws IOException
      Description copied from interface: Encoder
      End the current element in the encoding The current element must match the given annotation or an exception is thrown.
      Specified by:
      closeElement in interface Encoder
      Parameters:
      elemId - is the given (expected) annotation for the current element
      Throws:
      IOException - for errors in the underlying stream

    • writeBool

      public void writeBool(AttributeId attribId, boolean val) throws IOException
      Description copied from interface: Encoder
      Write an annotated boolean value into the encoding The boolean data is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeBool in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      val - is boolean value to encode
      Throws:
      IOException - for errors in the underlying stream

    • writeSignedInteger

      public void writeSignedInteger(AttributeId attribId, long val) throws IOException
      Description copied from interface: Encoder
      Write an annotated signed integer value into the encoding The integer is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeSignedInteger in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      val - is the signed integer value to encode
      Throws:
      IOException - for errors in the underlying stream

    • writeUnsignedInteger

      public void writeUnsignedInteger(AttributeId attribId, long val) throws IOException
      Description copied from interface: Encoder
      Write an annotated unsigned integer value into the encoding The integer is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeUnsignedInteger in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      val - is the unsigned integer value to encode
      Throws:
      IOException - for errors in the underlying stream

    • writeString

      public void writeString(AttributeId attribId, String val) throws IOException
      Description copied from interface: Encoder
      Write an annotated string into the encoding The string is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeString in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      val - is the string to encode
      Throws:
      IOException - for errors in the underlying stream

    • writeStringIndexed

      public void writeStringIndexed(AttributeId attribId, int index, String val) throws IOException
      Description copied from interface: Encoder
      Write an annotated string, using an indexed attribute, into the encoding. Multiple attributes with a shared name can be written to the same element by calling this method multiple times with a different index value. The encoding will use attribute ids up to the base id plus the maximum index passed in. Implementors must be careful to not use other attributes with ids bigger than the base id within the element taking the indexed attribute.
      Specified by:
      writeStringIndexed in interface Encoder
      Parameters:
      attribId - is the shared AttributeId
      index - is the unique index to associated with the string
      val - is the string to encode
      Throws:
      IOException - for errors in the underlying stream

    • writeSpace

      public void writeSpace(AttributeId attribId, AddressSpace spc) throws IOException
      Description copied from interface: Encoder
      Write an address space reference into the encoding The address space is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeSpace in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      spc - is the address space to encode
      Throws:
      IOException - for errors in the underlying stream

    • writeSpace

      public void writeSpace(AttributeId attribId, int index, String name) throws IOException
      Description copied from interface: Encoder
      Write an address space reference into the encoding. An address space identified by its name and unique index is associated with the given annotation and the current open element.
      Specified by:
      writeSpace in interface Encoder
      Parameters:
      attribId - is the given annotation
      index - is the unique index of the address space
      name - is the name of the address space
      Throws:
      IOException - for errors in the underlying stream

    • writeOpcode

      public void writeOpcode(AttributeId attribId, int opcode) throws IOException
      Description copied from interface: Encoder
      Write a p-code operation opcode into the encoding, associating it with the given annotation. The opcode is specified based on the constants defined in PcodeOp.
      Specified by:
      writeOpcode in interface Encoder
      Parameters:
      attribId - is the given annotation
      opcode - is the opcode constant
      Throws:
      IOException - for errors in the underlying stream

    • writeTo

      public void writeTo(OutputStream stream) throws IOException
      Description copied from interface: CachedEncoder
      Dump all the accumulated bytes in this encoder to the stream.
      Specified by:
      writeTo in interface CachedEncoder
      Parameters:
      stream - is the output stream
      Throws:
      IOException - for errors during the write operation

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: CachedEncoder
      The encoder is considered empty if the writeTo() method would output zero bytes
      Specified by:
      isEmpty in interface CachedEncoder
      Returns:
      true if there are no bytes in the encoder