Package ghidra.app.util.viewer.field

Class FunctionTagFieldFactory

java.lang.Object

ghidra.app.util.viewer.field.FieldFactory

ghidra.app.util.viewer.field.FunctionTagFieldFactory

All Implemented Interfaces:

ExtensionPoint

public class FunctionTagFieldFactory
extends FieldFactory

Generates a text label that lists the function tags for each Function. The label will will appear as part of the FUNCTION group in the field map.

Nested Class Summary

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

ExtensionPoint.Exclude, ExtensionPoint.Util

Field Summary

Fields

Modifier and Type	Field	Description
static java.awt.Color	DEFAULT_COLOR
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

Constructor	Description
FunctionTagFieldFactory()	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.
protected java.util.List<FieldElement>	createFunctionTagElements(FunctionDB function)	Creates a tags list field to be show at the beginning of each function that shows the tags assigned to that function.
void	displayOptionsChanged(Options options, java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)	Notifications that the display options changed.
ListingField	getField(ProxyObj<?> proxy, int varWidth)	PUBLIC METHODS
FieldLocation	getFieldLocation(ListingField listingField, java.math.BigInteger index, int fieldNum, ProgramLocation programLoc)	Overridden to ensure that we only place function tag text on the header of a function.
ProgramLocation	getProgramLocation(int row, int col, ListingField bf)	Overridden to ensure that we return` a FunctionTagFieldLocation instance.
FieldFactory	newInstance(FieldFormatModel formatModel, HighlightProvider provider, ToolOptions displayOptions, 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

fieldOptionsChanged, getDefaultColor, 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

DEFAULT_COLOR

public static final java.awt.Color DEFAULT_COLOR

Constructor Detail

FunctionTagFieldFactory

public FunctionTagFieldFactory()

Default Constructor

Method Detail

getField

public ListingField getField(ProxyObj<?> proxy,
                             int varWidth)

PUBLIC METHODS

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)

Overridden to ensure that we return` a FunctionTagFieldLocation instance.

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 listingField,
                                      java.math.BigInteger index,
                                      int fieldNum,
                                      ProgramLocation programLoc)

Overridden to ensure that we only place function tag text on the header of a function.

Specified by:

getFieldLocation in class FieldFactory

Parameters:

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

public FieldFactory newInstance(FieldFormatModel formatModel,
                                HighlightProvider provider,
                                ToolOptions displayOptions,
                                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.

displayOptions - the Options for display properties.

fieldOptions - the Options for field specific properties.

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.

createFunctionTagElements

protected java.util.List<FieldElement> createFunctionTagElements(FunctionDB function)

Creates a tags list field to be show at the beginning of each function that shows the tags assigned to that function.

Parameters:

function - the function to retrieve the tags from