Package ghidra.app.util.importer

Class ProgramLoader.Builder

java.lang.Object

ghidra.app.util.importer.ProgramLoader.Builder

Enclosing class:

ProgramLoader

public static class ProgramLoader.Builder
extends Object

A class to configure and perform a Program load

Method Summary

Modifier and Type	Method	Description
ProgramLoader.Builder	addLoaderArg(String name, String value)	Adds the given Loader argument to use during import.
ProgramLoader.Builder	compiler(CompilerSpec cspec)	Sets the compiler to use during import.
ProgramLoader.Builder	compiler(CompilerSpecID id)	Sets the compiler to use during import.
ProgramLoader.Builder	compiler(String id)	Sets the compiler to use during import.
ProgramLoader.Builder	language(Language language)	Sets the language to use during import.
ProgramLoader.Builder	language(LanguageID id)	Sets the language to use during import.
ProgramLoader.Builder	language(String id)	Sets the language to use during import.
LoadResults<Program>	load()	Loads the specified source with this ProgramLoader.Builder's current configuration
ProgramLoader.Builder	loaderArgs(List<Pair<String,String>> args)	Sets the Loader arguments to use during import.
ProgramLoader.Builder	loaders(Class<? extends Loader> cls)	Sets the acceptable Loader to use during import.
ProgramLoader.Builder	loaders(String clsName)	Sets the acceptable Loader to use during import.
ProgramLoader.Builder	loaders(Predicate<Loader> filter)	Sets the acceptable Loaders to use during import.
ProgramLoader.Builder	loaders(List<Class<? extends Loader>> cls)	Sets the Loaders to use during import.
ProgramLoader.Builder	log(MessageLog messageLog)	Sets the log to use during import.
ProgramLoader.Builder	mirror(boolean shouldMirror)	Sets whether or not the absolute filesystem path of each Loaded Program should be mirrored in the project, rooted at the specified project folder path.
ProgramLoader.Builder	monitor(TaskMonitor mon)	Sets the TaskMonitor to use during import.
ProgramLoader.Builder	name(String name)	Sets the name to use for the imported Program.
ProgramLoader.Builder	project(Project p)	Sets the Project.
ProgramLoader.Builder	projectFolderPath(String path)	Sets the project folder path to load into.
ProgramLoader.Builder	source(byte[] b)	Sets the required import source to the given bytes
ProgramLoader.Builder	source(ByteProvider p)	Sets the required import source to the given ByteProvider.
ProgramLoader.Builder	source(FSRL f)	Sets the required import source to the given FSRL
ProgramLoader.Builder	source(File f)	Sets the required import source to the given File
ProgramLoader.Builder	source(String path)	Sets the required import source to the given filesystem path

Methods inherited from class java.lang.Object

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

Method Details

source

public ProgramLoader.Builder source(ByteProvider p)

Sets the required import source to the given ByteProvider.

NOTE: Any previously defined sources will be overwritten.

NOTE: Ownership of the given ByteProvider is not transfered to this ProgramLoader.Builder, so it is the responsibility of the caller to properly close it when done.

Parameters:

p - The ByteProvider to import. A null value will unset the source.

Returns:

This ProgramLoader.Builder

source

public ProgramLoader.Builder source(FSRL f)

Sets the required import source to the given FSRL

NOTE: Any previously defined sources will be overwritten

Parameters:

f - The FSRL to import. A null value will unset the source.

Returns:

This ProgramLoader.Builder

source

public ProgramLoader.Builder source(File f)

Sets the required import source to the given File

NOTE: Any previously defined sources will be overwritten

Parameters:

f - The File to import. A null value will unset the source.

Returns:

This ProgramLoader.Builder

source

public ProgramLoader.Builder source(byte[] b)

Sets the required import source to the given bytes

NOTE: load() will fail if a name(String) is not set

NOTE: Any previously defined sources will be overwritten

Parameters:

b - The bytes to import. A null value will unset the source.

Returns:

This ProgramLoader.Builder

source

public ProgramLoader.Builder source(String path)

Sets the required import source to the given filesystem path

NOTE: Any previously defined sources will be overwritten

Parameters:

path - The filesystem path to import. A null value will unset the source.

Returns:

This ProgramLoader.Builder

project

public ProgramLoader.Builder project(Project p)

Sets the Project. Loaders can use this to take advantage of existing DomainFolders and DomainFiles to do custom behaviors such as loading libraries.

By default, no Project is associated with the ProgramLoader.

Parameters:

p - The Project. A null value will unset the project.

Returns:

This ProgramLoader.Builder

projectFolderPath

public ProgramLoader.Builder projectFolderPath(String path)

Sets the project folder path to load into.

The default project folder path is the root of the project ("/").

Parameters:

path - The project folder path. A null value will revert the path back to the default value of ("/").

Returns:

This ProgramLoader.Builder

mirror

public ProgramLoader.Builder mirror(boolean shouldMirror)

Sets whether or not the absolute filesystem path of each Loaded Program should be mirrored in the project, rooted at the specified project folder path.

By default, mirroring is off.

Parameters:

shouldMirror - True if filesystem mirroring should happen; otherwise, false.

Returns:

This ProgramLoader.Builder

name

public ProgramLoader.Builder name(String name)

Sets the name to use for the imported Program.

The default is the Loader's preferred name.

Parameters:

name - The name to use for the imported Program. A null value will revert the name to the Loader's preferred name.

Returns:

This ProgramLoader.Builder

loaders

public ProgramLoader.Builder loaders(Predicate<Loader> filter)

Sets the acceptable Loaders to use during import.

By default, all Loaders are accepted (LoaderService.ACCEPT_ALL).

Parameters:

filter - A filter used to limit the Loaders used during import. A null value will revert back to the default (LoaderService.ACCEPT_ALL).

Returns:

This ProgramLoader.Builder

loaders

public ProgramLoader.Builder loaders(Class<? extends Loader> cls)

Sets the acceptable Loader to use during import.

By default, all Loaders are accepted (LoaderService.ACCEPT_ALL).

Parameters:

cls - The class of the Loader to use during import. A null value will revert back to the default (LoaderService.ACCEPT_ALL).

Returns:

This ProgramLoader.Builder

loaders

public ProgramLoader.Builder loaders(String clsName)
                              throws InvalidInputException

Sets the acceptable Loader to use during import.

By default, all Loaders are accepted (LoaderService.ACCEPT_ALL).

Parameters:

clsName - The class name of the Loader to use during import. A null value will revert back to the default (LoaderService.ACCEPT_ALL).

Returns:

This ProgramLoader.Builder

Throws:

InvalidInputException - if the given loader class name did not correspond to a Loader

loaders

public ProgramLoader.Builder loaders(List<Class<? extends Loader>> cls)

Sets the Loaders to use during import.

By default, all Loaders are accepted (LoaderService.ACCEPT_ALL).

Parameters:

cls - A List of classes of Loaders to use during import. A null value will revert back to the default (LoaderService.ACCEPT_ALL).

Returns:

This ProgramLoader.Builder

loaderArgs

public ProgramLoader.Builder loaderArgs(List<Pair<String,String>> args)

Sets the Loader arguments to use during import.

By default, no Loader arguments are used.

Parameters:

args - A List of Loader argument name/value Pairs to use during import. A null value will result in no Loader arguments being used.

Returns:

This ProgramLoader.Builder

addLoaderArg

public ProgramLoader.Builder addLoaderArg(String name,
 String value)

Adds the given Loader argument to use during import.

Parameters:

name - A single Loader argument name to use during import.

value - The value that corresponds to the argument name

Returns:

This ProgramLoader.Builder

language

public ProgramLoader.Builder language(String id)

Sets the language to use during import.

By default, the first "preferred" language is used.

Parameters:

id - The language id to use during import. A null value will result in the first "preferred" language being used.

Returns:

This ProgramLoader.Builder

language

public ProgramLoader.Builder language(LanguageID id)

Sets the language to use during import.

By default, the first "preferred" language is used.

Parameters:

id - The LanguageID to use during import. A null value will result in the first "preferred" language being used.

Returns:

This ProgramLoader.Builder

language

public ProgramLoader.Builder language(Language language)

Sets the language to use during import.

By default, the first "preferred" language is used.

Parameters:

language - The Language to use during import. A null value will result in the first "preferred" language being used.

Returns:

This ProgramLoader.Builder

compiler

public ProgramLoader.Builder compiler(String id)

Sets the compiler to use during import.

By default, the processor's default compiler is used.

Parameters:

id - The compiler spec id to use during import. A null value will result in the language's default compiler being used.

Returns:

This ProgramLoader.Builder

compiler

public ProgramLoader.Builder compiler(CompilerSpecID id)

Sets the compiler to use during import.

By default, the processor's default compiler is used.

Parameters:

id - The CompilerSpecID to use during import. A null value will result in the language's default compiler being used.

Returns:

This ProgramLoader.Builder

compiler

public ProgramLoader.Builder compiler(CompilerSpec cspec)

Sets the compiler to use during import.

By default, the processor's default compiler is used.

Parameters:

cspec - The CompilerSpec to use during import. A null value will result in the language's default compiler being used.

Returns:

This ProgramLoader.Builder

log

public ProgramLoader.Builder log(MessageLog messageLog)

Sets the log to use during import.

By default, no log is used.

Parameters:

messageLog - The log to use during import. A null value will result in not logging.

Returns:

This ProgramLoader.Builder

monitor

public ProgramLoader.Builder monitor(TaskMonitor mon)

Sets the TaskMonitor to use during import.

By default, TaskMonitor.DUMMY is used.

Parameters:

mon - The TaskMonitor to use during import. A null value will result in TaskMonitor.DUMMY being used.

Returns:

This ProgramLoader.Builder

load

public LoadResults<Program> load()
                          throws IOException,
LanguageNotFoundException,
CancelledException,
VersionException,
LoadException

Loads the specified source with this ProgramLoader.Builder's current configuration

Returns:

The LoadResults which contains one or more Loaded Programs (created but not saved)

Throws:

IOException - if there was an IO-related problem loading

LanguageNotFoundException - if there was a problem getting the language

CancelledException - if the operation was cancelled

VersionException - if there was an issue with database versions, probably due to a failed language upgrade

LoadException - if there was a problem loading