Class SameDirDebugInfoProvider

java.lang.Object

ghidra.app.util.bin.format.dwarf.external.SameDirDebugInfoProvider

All Implemented Interfaces:

DebugFileProvider, DebugInfoProvider

public class SameDirDebugInfoProvider
extends Object
implements DebugFileProvider

A DebugFileProvider that only looks in the program's original import directory for matching debug files.

A debug-link (filename+crc) specified debug file must exist in the binary's original import directory and must have a matching crc.

A build-id (20'ish byte hash) specified debug file must exist in the binary's original import directory, named "aabbcc...ff.debug"

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESC

Constructor Summary

Constructors

Constructor	Description
SameDirDebugInfoProvider(File progDir)	Creates a new SameDirDebugInfoProvider at the specified directory.

Method Summary

Modifier and Type	Method	Description
static SameDirDebugInfoProvider	create(String name, DebugInfoProviderCreatorContext context)	Creates a new SameDirDebugInfoProvider instance using the current program's import location.
String	getDescriptiveName()	Returns a human formatted string describing this provider, used in UI prompts or lists.
File	getFile(ExternalDebugInfo debugInfo, TaskMonitor monitor)	Searches for a debug file that fulfills the criteria specified in the ExternalDebugInfo.
String	getName()	Returns the name of this instance, which should be a serialized copy of this instance, typically like "something://serialized_data".
DebugInfoProviderStatus	getStatus(TaskMonitor monitor)	Returns DebugInfoProviderStatus representing this provider's current status.
static boolean	matches(String name)	Returns true if the specified name string specifies a SameDirDebugInfoProvider.

Methods inherited from class Object

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

Field Details

DESC

public static final String DESC

See Also:

• Constant Field Values

Constructor Details

SameDirDebugInfoProvider

public SameDirDebugInfoProvider(File progDir)

Creates a new SameDirDebugInfoProvider at the specified directory.

Parameters:

progDir - path to the program's import directory

Method Details

matches

public static boolean matches(String name)

Returns true if the specified name string specifies a SameDirDebugInfoProvider.

Parameters:

name - string to test

Returns:

boolean true if locString specifies a SameDirDebugInfoProvider

create

public static SameDirDebugInfoProvider create(String name,
 DebugInfoProviderCreatorContext context)

Creates a new SameDirDebugInfoProvider instance using the current program's import location.

Parameters:

name - unused

context - DebugInfoProviderCreatorContext

Returns:

new SameDirDebugInfoProvider instance

getName

public String getName()

Description copied from interface: DebugInfoProvider

Returns the name of this instance, which should be a serialized copy of this instance, typically like "something://serialized_data".

Specified by:

getName in interface DebugInfoProvider

Returns:

the name of this instance, which should be a serialized copy of this instance, typically like "something://serialized_data"

getDescriptiveName

public String getDescriptiveName()

Description copied from interface: DebugInfoProvider

Returns a human formatted string describing this provider, used in UI prompts or lists.

Specified by:

getDescriptiveName in interface DebugInfoProvider

Returns:

a human formatted string describing this provider, used in UI prompts or lists

getStatus

public DebugInfoProviderStatus getStatus(TaskMonitor monitor)

Description copied from interface: DebugInfoProvider

Returns DebugInfoProviderStatus representing this provider's current status.

Specified by:

getStatus in interface DebugInfoProvider

Parameters:

monitor - TaskMonitor

Returns:

DebugInfoProviderStatus representing this provider's current status

getFile

public File getFile(ExternalDebugInfo debugInfo,
 TaskMonitor monitor)
             throws IOException,
CancelledException

Description copied from interface: DebugFileProvider

Searches for a debug file that fulfills the criteria specified in the ExternalDebugInfo.

Specified by:

getFile in interface DebugFileProvider

Parameters:

debugInfo - search criteria

monitor - TaskMonitor

Returns:

File of the matching file, or null if not found

Throws:

IOException - if error

CancelledException - if cancelled