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

Class ExternalDebugFilesService

java.lang.Object

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

public class ExternalDebugFilesService
extends Object

A collection of providers that can be queried to find a DWARF external debug file. Typically this will be an ELF binary that contains the debug information that was stripped from the original ELF binary, but can also include ability to fetch original binaries as well as source files.

Constructor Summary

Constructors

Constructor	Description
ExternalDebugFilesService(DebugFileStorage storage, List<DebugInfoProvider> providers)	Creates a new instance using a DebugFileStorage, and a list of providers.

Method Summary

Modifier and Type	Method	Description
void	addProvider(DebugInfoProvider provider)	Adds a DebugInfoProvider as a location to search.
File	find(ExternalDebugInfo debugInfo, TaskMonitor monitor)	Searches for the specified external debug file.
static ExternalDebugFilesService	forProgram(Program program)	Get a new instance of ExternalDebugFilesService using the previously saved information (via saveToPrefs(ExternalDebugFilesService)), for the specified program.
static ExternalDebugFilesService	fromPrefs(DebugInfoProviderCreatorContext context)	Get a new instance of ExternalDebugFilesService using the previously saved information (via saveToPrefs(ExternalDebugFilesService)).
static ExternalDebugFilesService	getDefault()	Returns an ExternalDebugFilesService instance with default search locations.
static ExternalDebugFilesService	getMinimal()	Returns an ExternalDebugFilesService instance with no additional search locations.
List<DebugInfoProvider>	getProviders()	Returns the configured providers.
DebugFileStorage	getStorage()
static void	saveToPrefs(ExternalDebugFilesService service)	Serializes an ExternalDebugFilesService to a string and writes to the Ghidra global preferences.

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalDebugFilesService

public ExternalDebugFilesService(DebugFileStorage storage,
 List<DebugInfoProvider> providers)

Creates a new instance using a DebugFileStorage, and a list of providers.

Parameters:

storage - DebugFileStorage

providers - list of providers to search

Method Details

getStorage

public DebugFileStorage getStorage()

getProviders

public List<DebugInfoProvider> getProviders()

Returns the configured providers.

Returns:

list of providers

addProvider

public void addProvider(DebugInfoProvider provider)

Adds a DebugInfoProvider as a location to search.

Parameters:

provider - DebugInfoProvider to add

find

public File find(ExternalDebugInfo debugInfo,
 TaskMonitor monitor)
          throws IOException

Searches for the specified external debug file.

Parameters:

debugInfo - information about the external debug file

monitor - TaskMonitor

Returns:

found file, or null if not found

Throws:

IOException - if error

getMinimal

public static ExternalDebugFilesService getMinimal()

Returns an ExternalDebugFilesService instance with no additional search locations.

Returns:

an ExternalDebugFilesService instance with no additional search locations

getDefault

public static ExternalDebugFilesService getDefault()

Returns an ExternalDebugFilesService instance with default search locations.

Returns:

an ExternalDebugFilesService instance with default search locations

forProgram

public static ExternalDebugFilesService forProgram(Program program)

Get a new instance of ExternalDebugFilesService using the previously saved information (via saveToPrefs(ExternalDebugFilesService)), for the specified program.

Parameters:

program - Program

Returns:

new ExternalDebugFilesService instance

fromPrefs

public static ExternalDebugFilesService fromPrefs(DebugInfoProviderCreatorContext context)

Get a new instance of ExternalDebugFilesService using the previously saved information (via saveToPrefs(ExternalDebugFilesService)).

Parameters:

context - created via DebugInfoProviderRegistry.newContext(ghidra.program.model.listing.Program)

Returns:

new ExternalDebugFilesService instance

saveToPrefs

public static void saveToPrefs(ExternalDebugFilesService service)

Serializes an ExternalDebugFilesService to a string and writes to the Ghidra global preferences.

Parameters:

service - the ExternalDebugFilesService to commit to preferences