Package ghidra.app.util.pcode

Class PcodeFormatter

  • public class PcodeFormatter
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      PcodeFormatter()
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      OpTpl[] getPcodeOpTemplates​(AddressFactory addrFactory, PcodeOp[] pcodeOps)
      Convert flattened PcodeOp's into pcode operation templates.
      void setColor​(java.awt.Color addressColor, java.awt.Color registerColor, java.awt.Color scalarColor, java.awt.Color localColor)
      Set color options for AttributedString objects
      void setFontMetrics​(java.awt.FontMetrics metrics)
      Set font metrics for AttributedString objects
      void setOptions​(int maxDisplayLines, boolean displayRawPcode)
      Set general formatting options
      java.util.List<AttributedString> toAttributedStrings​(Program program, OpTpl[] pcodeOpTemplates)
      Format an array of pcode OpTpl objects as a list of AttributedString objects.
      java.util.List<AttributedString> toAttributedStrings​(Program program, PcodeOp[] pcodeOps)
      Format an array of PcodeOp objects as a two-dimensional list of AttributedString objects.
      java.lang.String toString​(Program program, OpTpl[] pcodeOpTemplates)
      Format an array of pcode OpTpl objects as a multi-line String
      java.lang.String toString​(Program program, PcodeOp[] pcodeOps)
      Format an array of PcodeOp objects as a multi-line String

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PcodeFormatter

        public PcodeFormatter()
        Constructor

    • Method Detail

      • setColor

        public void setColor​(java.awt.Color addressColor,
                     java.awt.Color registerColor,
                     java.awt.Color scalarColor,
                     java.awt.Color localColor)
        Set color options for AttributedString objects
        Parameters:
        addressColor -
        registerColor -
        scalarColor -
        localColor -

      • setFontMetrics

        public void setFontMetrics​(java.awt.FontMetrics metrics)
        Set font metrics for AttributedString objects
        Parameters:
        metrics -

      • setOptions

        public void setOptions​(int maxDisplayLines,
                       boolean displayRawPcode)
        Set general formatting options
        Parameters:
        maxDisplayLines -
        displayRawPcode -

      • toString

        public java.lang.String toString​(Program program,
                                 PcodeOp[] pcodeOps)
        Format an array of PcodeOp objects as a multi-line String
        Returns:
        pcode listing as a String

      • toAttributedStrings

        public java.util.List<AttributedString> toAttributedStrings​(Program program,
                                                            PcodeOp[] pcodeOps)
        Format an array of PcodeOp objects as a two-dimensional list of AttributedString objects. The returned list contains a separate element for each row of the pcode listing.
        Parameters:
        program -
        pcodeOps -
        Returns:
        pcode listing as a two-dimensional list of AttributedString objects

      • toString

        public java.lang.String toString​(Program program,
                                 OpTpl[] pcodeOpTemplates)
        Format an array of pcode OpTpl objects as a multi-line String
        Parameters:
        program -
        pcodeOpTemplates -
        Returns:
        pcode listing as a String

      • toAttributedStrings

        public java.util.List<AttributedString> toAttributedStrings​(Program program,
                                                            OpTpl[] pcodeOpTemplates)
        Format an array of pcode OpTpl objects as a list of AttributedString objects. The returned list contains a separate element for each row of the pcode listing.
        Parameters:
        program -
        pcodeOpTemplates -
        Returns:
        pcode listing as a two-dimensional list of AttributedString objects

      • getPcodeOpTemplates

        public OpTpl[] getPcodeOpTemplates​(AddressFactory addrFactory,
                                   PcodeOp[] pcodeOps)
        Convert flattened PcodeOp's into pcode operation templates.
        Parameters:
        addrFactory -
        pcodeOps -
        Returns:
        pcode operation templates