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

Class LocalDirDebugLinkProvider

java.lang.Object

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

All Implemented Interfaces:

DebugFileProvider, DebugInfoProvider

public class LocalDirDebugLinkProvider
extends Object
implements DebugFileProvider

Searches for DWARF external debug files specified via a debug-link filename / crc in a directory.

Constructor Summary

Constructors

Constructor	Description
LocalDirDebugLinkProvider(File searchDir)	Creates a new LocalDirDebugLinkProvider at the specified dir.

Method Summary

Modifier and Type	Method	Description
static int	calcCRC(File f)	Calculates the crc32 for the specified file.
static LocalDirDebugLinkProvider	create(String name, DebugInfoProviderCreatorContext context)	Creates a new LocalDirDebugLinkProvider instance using the specified name string.
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 LocalDirDebugLinkProvider.

Methods inherited from class java.lang.Object

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

Constructor Details

LocalDirDebugLinkProvider

public LocalDirDebugLinkProvider(File searchDir)

Creates a new LocalDirDebugLinkProvider at the specified dir.

Parameters:

searchDir - path to the root directory of where to search

Method Details

matches

public static boolean matches(String name)

Returns true if the specified name string specifies a LocalDirDebugLinkProvider.

Parameters:

name - string to test

Returns:

boolean true if name specifies a LocalDirDebugLinkProvider name

create

public static LocalDirDebugLinkProvider create(String name,
 DebugInfoProviderCreatorContext context)

Creates a new LocalDirDebugLinkProvider instance using the specified name string.

Parameters:

name - string, earlier returned from getName()

context - DebugInfoProviderCreatorContext to allow accessing information outside of the name string that might be needed to create a new instance

Returns:

new LocalDirDebugLinkProvider 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 CancelledException,
IOException

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:

CancelledException - if cancelled

IOException - if error

calcCRC

public static int calcCRC(File f)
                   throws IOException

Calculates the crc32 for the specified file.

Parameters:

f - File to read

Returns:

int crc32

Throws:

IOException - if error reading file