Package ghidra.taint.gui.field

Class TaintFieldFactory

java.lang.Object

ghidra.app.util.viewer.field.FieldFactory

ghidra.taint.gui.field.TaintFieldFactory

All Implemented Interfaces:

ExtensionPoint

public class TaintFieldFactory
extends FieldFactory

A field factory for "Taint" in the Listing panels

This implements an interface that is part of the core framework, even lower than the Debugger framework. I used the "sample" module's EntropyFieldFactory for reference.

Field Summary

Fields

Modifier and Type	Field	Description
static final GColor	COLOR
static final String	FIELD_NAME
static final String	PROPERTY_NAME

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

BASE_LISTING_FONT_ID, baseFont, colorOptionName, enabled, FONT_OPTION_NAME, hlProvider, model, name, startX, style, styleOptionName, width

Constructor Summary

Constructors

Modifier	Constructor	Description
	TaintFieldFactory()
protected	TaintFieldFactory(FieldFormatModel formatModel, ListingHighlightProvider highlightProvider, Options displayOptions, Options fieldOptions)

Method Summary

Modifier and Type	Method	Description
boolean	acceptsType(int category, Class<?> proxyObjectClass)	Used to specify which format models this field can belong to.
ListingField	getField(ProxyObj<?> proxy, int varWidth)	Generates a Field based on the given information.
FieldLocation	getFieldLocation(ListingField bf, 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 row, int col, ListingField bf)	Returns the Program location for the given object, row, col, and groupPath
FieldFactory	newInstance(FieldFormatModel formatModel, ListingHighlightProvider highlightProvider, 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

displayOptionsChanged, fieldOptionsChanged, getFieldModel, getFieldName, getFieldText, getMetrics, getMetrics, getStartX, getWidth, hasSamePath, initDisplayOptions, initFieldOptions, isEnabled, servicesChanged, setEnabled, setStartX, setWidth, simplifyTemplates, supportsLocation

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_NAME

public static final String PROPERTY_NAME

See Also:

• Constant Field Values

COLOR

public static final GColor COLOR

FIELD_NAME

public static final String FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

TaintFieldFactory

public TaintFieldFactory()

TaintFieldFactory

protected TaintFieldFactory(FieldFormatModel formatModel,
 ListingHighlightProvider highlightProvider,
 Options displayOptions,
 Options fieldOptions)

Method Details

newInstance

public FieldFactory newInstance(FieldFormatModel formatModel,
 ListingHighlightProvider highlightProvider,
 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.

highlightProvider - the HightLightProvider.

displayOptions - the Options for display properties.

fieldOptions - the Options for field specific properties.

Returns:

the factory

getField

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

Generates a Field based on the given information.

This is where the most of the rendering logic is. Here, we access the property map and deserialize into a TaintVec manually (as compared to using a state piece as we did in TaintDebuggerRegisterColumnFactory). Once we have the complete vector, we render it for display.

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.

getFieldLocation

public FieldLocation getFieldLocation(ListingField bf,
 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). Each FieldFactory should generate and process a unique ProgramLocation class.

Because the core framework provides an API for accessing and manipulating the user's cursor, we have to provide a means to distinguish locations in our field from others. This method provides on direction of the conversion between field and program locations.

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.

getProgramLocation

public ProgramLocation getProgramLocation(int row,
 int col,
 ListingField bf)

Returns the Program location for the given object, row, col, and groupPath

Because the core framework provides an API for accessing and manipulating the user's cursor, we have to provide a means to distinguish locations in our field from others. This method provides on direction of the conversion between field and program locations.

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.

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.