Package ghidra.app.util.viewer.field

Class PreCommentFieldFactory

java.lang.Object

ghidra.app.util.viewer.field.FieldFactory

ghidra.app.util.viewer.field.PreCommentFieldFactory

All Implemented Interfaces:

ExtensionPoint

public class PreCommentFieldFactory
extends FieldFactory

Generates pre-comment fields.

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint

ExtensionPoint.Exclude, ExtensionPoint.Util

Field Summary

Fields

Change	Modifier and Type	Field	Description
MODIFIED	static java.lang.String	ENABLE_ALWAYS_SHOW_AUTOMATIC_MSG
MODIFIED	static java.lang.String	ENABLE_WORD_WRAP_MSG
	static java.lang.String	FIELD_NAME

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

Change	Constructor	Description
PreCommentFieldFactory()	Constructor

Method Summary

Change	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	fieldOptionsChanged(Options options, java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)	Notifications that the field options 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 programLoc)	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 row, int col, ListingField bf)	Returns the Program location for the given object, row, col, and groupPath
MODIFIED	FieldFactory	newInstance(FieldFormatModel formatModel, HighlightProvider provider, ToolOptions toolOptions, ToolOptions fieldOptions)	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

displayOptionsChanged, 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 MODIFIED

constant: "Pre-Comment.Enable Word Wrapping" → "Pre-comments Field.Enable Word Wrapping"

-static java.lang.String ENABLE_WORD_WRAP_MSG

+static java.lang.String ENABLE_WORD_WRAP_MSG

public static final java.lang.String ENABLE_WORD_WRAP_MSG

See Also:

Constant Field Values

ENABLE_ALWAYS_SHOW_AUTOMATIC_MSG MODIFIED

constant: "Pre-Comment.Always Show the Automatic Comment" → "Pre-comments Field.Always Show the Automatic Comment"

-static java.lang.String ENABLE_ALWAYS_SHOW_AUTOMATIC_MSG

+static java.lang.String ENABLE_ALWAYS_SHOW_AUTOMATIC_MSG

public static final java.lang.String ENABLE_ALWAYS_SHOW_AUTOMATIC_MSG

See Also:

Constant Field Values

Constructor Detail

PreCommentFieldFactory

public PreCommentFieldFactory()

Constructor

Method Detail

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 row,
                                          int col,
                                          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:

row - the row within this field

col - the col on the given row within this field.

bf - the ListingField containing the cursor.

getFieldLocation

public FieldLocation getFieldLocation(ListingField bf,
                                      java.math.BigInteger index,
                                      int fieldNum,
                                      ProgramLocation programLoc)

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.

programLoc - 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 MODIFIED

param 3 renamed: displayOptions → toolOptions

-ghidra.app.util.viewer.field.FieldFactory newInstance(ghidra.app.util.viewer.format.FieldFormatModel formatModel, ghidra.app.util.HighlightProvider provider, ghidra.framework.options.ToolOptions displayOptions, ghidra.framework.options.ToolOptions fieldOptions)

+ghidra.app.util.viewer.field.FieldFactory newInstance(ghidra.app.util.viewer.format.FieldFormatModel formatModel, ghidra.app.util.HighlightProvider provider, ghidra.framework.options.ToolOptions toolOptions, ghidra.framework.options.ToolOptions fieldOptions)

public FieldFactory newInstance(FieldFormatModel formatModel,
                                HighlightProvider provider,
                                ToolOptions toolOptions,
                                ToolOptions fieldOptions)

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:

formatModel - the model that the field belongs to.

provider - the HightLightProvider.

toolOptions - the Options for display properties.

fieldOptions - 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

fieldOptionsChanged

public void fieldOptionsChanged(Options options,
                                java.lang.String optionName,
                                java.lang.Object oldValue,
                                java.lang.Object newValue)

Description copied from class: FieldFactory

Notifications that the field options changed.

Overrides:

fieldOptionsChanged in class FieldFactory

Parameters:

options - the Field 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.