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

Class LocalDirectorySearchLocation

java.lang.Object

ghidra.app.util.bin.format.dwarf4.external.LocalDirectorySearchLocation

All Implemented Interfaces:

SearchLocation

public class LocalDirectorySearchLocation
extends java.lang.Object
implements SearchLocation

A SearchLocation that recursively searches for dwarf external debug files under a configured directory.

Constructor Summary

Constructors

Constructor	Description
LocalDirectorySearchLocation(java.io.File searchDir)	Creates a new LocalDirectorySearchLocation at the specified location.

Method Summary

Modifier and Type	Method	Description
static int	calcCRC(java.io.File f)	Calculates the crc32 for the specified file.
static LocalDirectorySearchLocation	create(java.lang.String locString, SearchLocationCreatorContext context)	Creates a new LocalDirectorySearchLocation instance using the specified location string.
FSRL	findDebugFile(ExternalDebugInfo debugInfo, TaskMonitor monitor)	Searchs for a debug file that fulfills the criteria specified in the ExternalDebugInfo.
java.lang.String	getDescriptiveName()	Returns a human formatted string describing this location, used in UI prompts or lists.
java.lang.String	getName()	Returns the name of this instance, which should be a serialized copy of this instance.
static boolean	isLocalDirSearchLoc(java.lang.String locString)	Returns true if the specified location string specifies a LocalDirectorySearchLocation.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalDirectorySearchLocation

public LocalDirectorySearchLocation(java.io.File searchDir)

Creates a new LocalDirectorySearchLocation at the specified location.

Parameters:

searchDir - path to the root directory of where to search

Method Detail

isLocalDirSearchLoc

public static boolean isLocalDirSearchLoc(java.lang.String locString)

Returns true if the specified location string specifies a LocalDirectorySearchLocation.

Parameters:

locString - string to test

Returns:

boolean true if locString specifies a local dir search location

create

public static LocalDirectorySearchLocation create(java.lang.String locString,
                                                  SearchLocationCreatorContext context)

Creates a new LocalDirectorySearchLocation instance using the specified location string.

Parameters:

locString - string, earlier returned from getName()

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

Returns:

new LocalDirectorySearchLocation instance

getName

public java.lang.String getName()

Description copied from interface: SearchLocation

Returns the name of this instance, which should be a serialized copy of this instance.

Specified by:

getName in interface SearchLocation

Returns:

String serialized data of this instance, typically in "something://serialized_data" form

getDescriptiveName

public java.lang.String getDescriptiveName()

Description copied from interface: SearchLocation

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

Specified by:

getDescriptiveName in interface SearchLocation

Returns:

formatted string

findDebugFile

public FSRL findDebugFile(ExternalDebugInfo debugInfo,
                          TaskMonitor monitor)
                   throws CancelledException,
                          java.io.IOException

Description copied from interface: SearchLocation

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

Specified by:

findDebugFile in interface SearchLocation

Parameters:

debugInfo - search criteria

monitor - TaskMonitor

Returns:

FSRL of the matching file, or null if not found

Throws:

CancelledException - if cancelled

java.io.IOException - if error

calcCRC

public static int calcCRC(java.io.File f)
                   throws java.io.IOException

Calculates the crc32 for the specified file.

Parameters:

f - File to read

Returns:

int crc32

Throws:

java.io.IOException - if error reading file