Package ghidra.app.util.viewer.field

Class EolCommentFieldFactory

java.lang.Object
ghidra.app.util.viewer.field.FieldFactory
ghidra.app.util.viewer.field.EolCommentFieldFactory
All Implemented Interfaces:
ExtensionPoint
public class EolCommentFieldFactory extends FieldFactory
Generates End of line comment Fields.

  • Field Details

  • Constructor Details

    • EolCommentFieldFactory

      public EolCommentFieldFactory()
      Default Constructor

  • Method Details

    • fieldOptionsChanged

      public void fieldOptionsChanged(Options options, String optionName, Object oldValue, Object newValue)
      Notification that an option changed.
      Overrides:
      fieldOptionsChanged in class FieldFactory
      Parameters:
      options - options object containing the property that changed
      optionName - name of option that changed
      oldValue - old value of the option
      newValue - new value of the option

    • displayOptionsChanged

      public void displayOptionsChanged(Options options, String optionName, Object oldValue, Object newValue)
      Description copied from class: FieldFactory
      Notifications that the display options changed.
      Overrides:
      displayOptionsChanged in class FieldFactory
      Parameters:
      options - the Display Options object that changed.
      optionName - the name of the property that changed.
      oldValue - the old value of the property.
      newValue - the new value of the property.

    • getField

      public ListingField getField(ProxyObj<?> proxy, int varWidth)
      Description copied from class: FieldFactory
      Generates a Field based on the given information.
      Specified by:
      getField in class FieldFactory
      Parameters:
      proxy - The object that the generated field will report some information about.
      varWidth - the additional distance along the x axis to place the generated field.
      Returns:
      the newly generated FactoryField that shows some property or information about the given object.

    • getProgramLocation

      public ProgramLocation getProgramLocation(int screenRow, int screenColumn, ListingField bf)
      Description copied from class: FieldFactory
      Returns the Program location for the given object, row, col, and groupPath
      Specified by:
      getProgramLocation in class FieldFactory
      Parameters:
      screenRow - the row location for the cursor within the listing field.
      screenColumn - the column location for the cursor within the listing field.
      bf - the listing field.
      Returns:
      the program location that is equivalent to the cursor location in the field.

    • getFieldLocation

      public FieldLocation getFieldLocation(ListingField bf, BigInteger index, int fieldNum, ProgramLocation loc)
      Description copied from class: FieldFactory
      Return a FieldLocation that corresponds to the given index, fieldNum, and ProgramLocation IF and ONLY IF the given programLocation is the type generated by this class's FieldFactory.getFieldLocation(ListingField, BigInteger, int, ProgramLocation). Each FieldFactory should generate and process a unique ProgramLocation class.
      Specified by:
      getFieldLocation in class FieldFactory
      Parameters:
      bf - the ListingField at the current cursor.
      index - the line index (corresponds to an address)
      fieldNum - the index of field within the layout to try and get a FieldLocation.
      loc - the ProgramLocation to be converted into a FieldLocation.
      Returns:
      the location.

    • acceptsType

      public boolean acceptsType(int category, Class<?> proxyObjectClass)
      Description copied from class: FieldFactory
      Used to specify which format models this field can belong to.
      Specified by:
      acceptsType in class FieldFactory
      Parameters:
      category - the category for this field
      proxyObjectClass - the type of proxy object used by this field
      Returns:
      true if this class accepts the given category.

    • newInstance

      public FieldFactory newInstance(FieldFormatModel fieldFormatModel, ListingHighlightProvider highlightProvider, ToolOptions newDisplayOptions, ToolOptions newFieldOptions)
      Description copied from class: FieldFactory
      Returns a new instance of this FieldFactory that can be used to generate fields instead of being used as a prototype.
      Specified by:
      newInstance in class FieldFactory
      Parameters:
      fieldFormatModel - the model that the field belongs to.
      highlightProvider - the HightLightProvider.
      newDisplayOptions - the Options for display properties.
      newFieldOptions - the Options for field specific properties.
      Returns:
      the factory

    • getSingleString

      public static String getSingleString(String[] comments, char separatorChar)
      Convert the array of comments to a single string and use the given separatorChar as the delimiter.
      Parameters:
      comments - array of comments to convert
      separatorChar - character to insert after each element in the comment array
      Returns:
      the converted string