Package ghidra.app.util

Class EolComments

java.lang.Object
ghidra.app.util.EolComments
public class EolComments extends Object
Utility class with methods to get comment information that can be displayed in the end of line comment field. Each instance of this class is associated with a code unit. This class uses the provided options to decide how to load and filter existing comments.

Comment types that can be shown include the End of Line comment for the code unit, the Repeatable comment for the code unit, any repeatable comments for the code units that this code unit has references to, and possibly a comment indicating the data at a code unit that is referenced by this code unit. This section describes the various EOL comment types that may appear. The user can toggle which types are enabled. The comments are displayed in the order listed below. EOL Types: - EOL - user end of line comment - Repeatable - user repeatable source comment *at the code unit* - Ref Repeatable- for every reference *from a code unit*, show the target: - address repeatable, - function repeatable, - code unit repeatable - Auto - fabricated reference preview: - function, - indirect data pointer, - direct data access preview *depending on the options, this typically do not appear when repeatable comments exist - Offcut - comments at addresses inside of a code unit

  • Constructor Details

    • EolComments

      public EolComments(CodeUnit cu, boolean operandsShowReferences, int maxDisplayComments, EolExtraCommentsOption extraCommentsOption)

  • Method Details

    • isShowingRepeatables

      public boolean isShowingRepeatables()

    • isShowingRefRepeatables

      public boolean isShowingRefRepeatables()

    • isShowingAutoComments

      public boolean isShowingAutoComments()

    • isShowingOffcutComments

      public boolean isShowingOffcutComments()

    • getComments

      public List<String> getComments()
      Return all comments loaded by this class
      Returns:
      the comments

    • getEOLComments

      public List<String> getEOLComments()
      Gets the End of Line comments
      Returns:
      the comments

    • getRepeatableComments

      public List<String> getRepeatableComments()
      Gets the repeatable comments
      Returns:
      the comments

    • getReferencedRepeatableComments

      public List<RefRepeatComment> getReferencedRepeatableComments()
      Gets the repeatable comments at the "to reference"s
      Returns:
      the comments

    • getAutomaticComment

      public List<String> getAutomaticComment()
      Gets the automatic comments
      Returns:
      the comments

    • getOffcutEolComments

      public List<String> getOffcutEolComments()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getRowCol

      public RowColLocation getRowCol(CommentFieldLocation cloc)

    • getLocation

      public ProgramLocation getLocation(int eolRow, int eolColumn)