Package ghidra.app.plugin.core.data

Class ProgramStructureProviderContext

java.lang.Object

ghidra.app.plugin.core.data.ProgramStructureProviderContext

All Implemented Interfaces:

DataTypeProviderContext

public class ProgramStructureProviderContext
extends java.lang.Object
implements DataTypeProviderContext

Constructor Summary

Constructors

Constructor	Description
ProgramStructureProviderContext(Program program, Address addr, Structure struct, int myOffset)
ProgramStructureProviderContext(Program program, ProgramLocation loc)

Method Summary

Modifier and Type	Method	Description
DataTypeComponent	getDataTypeComponent(int offset)	Get one data type from buffer at the current position plus offset.
DataTypeComponent[]	getDataTypeComponents(int start, int end)	Get an array of CodePrototypes that begin at or after start up to end.
java.lang.String	getUniqueName(java.lang.String baseName)	Get a unique name for a data type given a prefix name

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgramStructureProviderContext

public ProgramStructureProviderContext(Program program,
                                       ProgramLocation loc)

ProgramStructureProviderContext

public ProgramStructureProviderContext(Program program,
                                       Address addr,
                                       Structure struct,
                                       int myOffset)

Method Detail

getDataTypeComponent

public DataTypeComponent getDataTypeComponent(int offset)

Description copied from interface: DataTypeProviderContext

Get one data type from buffer at the current position plus offset.

Specified by:

getDataTypeComponent in interface DataTypeProviderContext

Parameters:

offset - the displacement from the current position.

Returns:

the data type at offset from the current position.

getDataTypeComponents

public DataTypeComponent[] getDataTypeComponents(int start,
                                                 int end)

Get an array of CodePrototypes that begin at or after start up to end. Prototypes that exist before start are not returned Prototypes that exist before end, but terminate after end ARE returned The prototypes must be contiguous from start to end

Specified by:

getDataTypeComponents in interface DataTypeProviderContext

Parameters:

start - start offset

end - end offset

Returns:

array of CodePrototypes that exist between start and end.

getUniqueName

public java.lang.String getUniqueName(java.lang.String baseName)

Description copied from interface: DataTypeProviderContext

Get a unique name for a data type given a prefix name

Specified by:

getUniqueName in interface DataTypeProviderContext

Parameters:

baseName - prefix for unique name

Returns:

a unique data type name