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 Summary

Fields

Modifier and Type	Field	Description
static java.awt.Color	DEFAULT_COLOR
static java.lang.String	ENABLE_ALWAYS_SHOW_AUTOMATIC_MSG
static java.lang.String	ENABLE_ALWAYS_SHOW_REF_REPEATABLE_MSG
static java.lang.String	ENABLE_ALWAYS_SHOW_REPEATABLE_MSG
static java.lang.String	ENABLE_PREPEND_REF_ADDRESS_MSG
static java.lang.String	ENABLE_SHOW_SEMICOLON_MSG
static java.lang.String	ENABLE_WORD_WRAP_MSG
static java.lang.String	FIELD_NAME
static java.lang.String	MAX_DISPLAY_LINES_MSG
static java.lang.String	SHOW_FUNCTION_AUTOMITIC_COMMENT_MSG
static java.lang.String	USE_ABBREVIATED_AUTOMITIC_COMMENT_MSG

Fields inherited from class ghidra.app.util.viewer.field.FieldFactory

baseFont, color, colorOptionName, DEFAULT_FIELD_FONT, displayOptions, enabled, FONT_OPTION_NAME, hlProvider, model, name, startX, style, styleOptionName, underlineColor, width

Constructor Summary

Constructors

Constructor	Description
EolCommentFieldFactory()	Default Constructor

Method Summary

Modifier and Type	Method	Description
boolean	acceptsType(int category, java.lang.Class<?> proxyObjectClass)	Used to specify which format models this field can belong to.
void	displayOptionsChanged(Options options, java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)	Notifications that the display options changed.
void	fieldOptionsChanged(Options options, java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)	Notification that an option changed.
java.awt.Color	getDefaultColor()	Returns the default field color.
ListingField	getField(ProxyObj<?> proxy, int varWidth)	Generates a Field based on the given information.
FieldLocation	getFieldLocation(ListingField bf, java.math.BigInteger index, int fieldNum, ProgramLocation loc)	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).
ProgramLocation	getProgramLocation(int screenRow, int screenColumn, ListingField bf)	Returns the Program location for the given object, row, col, and groupPath
static java.lang.String	getSingleString(java.lang.String[] comments, char separatorChar)	Convert the array of comments to a single string and use the given separatorChar as the delimiter.
FieldFactory	newInstance(FieldFormatModel fieldFormatModel, HighlightProvider highlightProvider, ToolOptions newDisplayOptions, ToolOptions newFieldOptions)	Returns a new instance of this FieldFactory that can be used to generate fields instead of being used as a prototype.

Methods inherited from class ghidra.app.util.viewer.field.FieldFactory

getFieldModel, getFieldName, getFieldText, getMetrics, getMetrics, getStartX, getWidth, hasSamePath, initDisplayOptions, isEnabled, optionsChanged, servicesChanged, setEnabled, setStartX, setWidth

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_NAME

public static final java.lang.String FIELD_NAME

See Also:

Constant Field Values

ENABLE_WORD_WRAP_MSG

public static final java.lang.String ENABLE_WORD_WRAP_MSG

See Also:

Constant Field Values

MAX_DISPLAY_LINES_MSG

public static final java.lang.String MAX_DISPLAY_LINES_MSG

See Also:

Constant Field Values

ENABLE_SHOW_SEMICOLON_MSG

public static final java.lang.String ENABLE_SHOW_SEMICOLON_MSG

See Also:

Constant Field Values

ENABLE_ALWAYS_SHOW_REPEATABLE_MSG

public static final java.lang.String ENABLE_ALWAYS_SHOW_REPEATABLE_MSG

See Also:

Constant Field Values

ENABLE_ALWAYS_SHOW_REF_REPEATABLE_MSG

public static final java.lang.String ENABLE_ALWAYS_SHOW_REF_REPEATABLE_MSG

See Also:

Constant Field Values

ENABLE_ALWAYS_SHOW_AUTOMATIC_MSG

public static final java.lang.String ENABLE_ALWAYS_SHOW_AUTOMATIC_MSG

See Also:

Constant Field Values

USE_ABBREVIATED_AUTOMITIC_COMMENT_MSG

public static final java.lang.String USE_ABBREVIATED_AUTOMITIC_COMMENT_MSG

See Also:

Constant Field Values

SHOW_FUNCTION_AUTOMITIC_COMMENT_MSG

public static final java.lang.String SHOW_FUNCTION_AUTOMITIC_COMMENT_MSG

See Also:

Constant Field Values

ENABLE_PREPEND_REF_ADDRESS_MSG

public static final java.lang.String ENABLE_PREPEND_REF_ADDRESS_MSG

See Also:

Constant Field Values

DEFAULT_COLOR

public static final java.awt.Color DEFAULT_COLOR

Constructor Detail

EolCommentFieldFactory

public EolCommentFieldFactory()

Default Constructor

Method Detail

fieldOptionsChanged

public void fieldOptionsChanged(Options options,
                                java.lang.String optionName,
                                java.lang.Object oldValue,
                                java.lang.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,
                                  java.lang.String optionName,
                                  java.lang.Object oldValue,
                                  java.lang.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,
                                      java.math.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.

acceptsType

public boolean acceptsType(int category,
                           java.lang.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,
                                HighlightProvider 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.

getDefaultColor

public java.awt.Color getDefaultColor()

Description copied from class: FieldFactory

Returns the default field color.

Overrides:

getDefaultColor in class FieldFactory

getSingleString

public static java.lang.String getSingleString(java.lang.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