Package ghidra.app.util.opinion

Class XmlLoader

java.lang.Object

ghidra.app.util.opinion.AbstractProgramLoader

ghidra.app.util.opinion.XmlLoader

All Implemented Interfaces:

Loader, ExtensionPoint, Comparable<Loader>

public class XmlLoader
extends AbstractProgramLoader

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_SRC_NAME

Fields inherited from class ghidra.app.util.opinion.AbstractProgramLoader

ANCHOR_LABELS_OPTION_NAME, APPLY_LABELS_OPTION_NAME

Fields inherited from interface ghidra.app.util.opinion.Loader

COMMAND_LINE_ARG_PREFIX, loggingDisabled, OPTIONS_PROJECT_SAVE_STATE_KEY

Constructor Summary

Constructors

Constructor	Description
XmlLoader()

Method Summary

Modifier and Type	Method	Description
Collection<LoadSpec>	findSupportedLoadSpecs(ByteProvider provider)	If this Loader supports loading the given ByteProvider, this methods returns a Collection of all supported LoadSpecs that contain discovered load specification information that this Loader will need to load.
List<Option>	getDefaultOptions(ByteProvider provider, LoadSpec loadSpec, DomainObject domainObject, boolean loadIntoProgram)	Gets the default Loader options.
String	getName()	Gets the Loader's name, which is used both for display purposes, and to identify the Loader in the opinion files.
String	getPreferredFileName(ByteProvider provider)	The preferred file name to use when loading.
LoaderTier	getTier()	For ordering purposes; lower tier numbers are more important (and listed first).
int	getTierPriority()	For ordering purposes; lower numbers are more important (and listed first, within its tier).
protected List<Loaded<Program>>	loadProgram(ByteProvider provider, String programName, Project project, String programFolderPath, LoadSpec loadSpec, List<Option> options, MessageLog log, Object consumer, TaskMonitor monitor)	Loads bytes in a particular format as a new Loaded Program.
protected void	loadProgramInto(ByteProvider provider, LoadSpec loadSpec, List<Option> options, MessageLog log, Program prog, TaskMonitor monitor)	Loads program bytes into the specified Program.
boolean	supportsLoadIntoProgram()	Checks to see if this Loader supports loading into an existing Program.
String	validateOptions(ByteProvider provider, LoadSpec loadSpec, List<Option> options, Program program)	Validates the Loader's options and returns null if all options are valid; otherwise, an error message describing the problem is returned.

Methods inherited from class ghidra.app.util.opinion.AbstractProgramLoader

concatenatePaths, createDefaultMemoryBlocks, createProgram, generateBlockName, getLanguageService, load, loadInto, markAsFunction, postLoadCleanup, postLoadProgramFixups, release, setProgramProperties, shouldApplyProcessorLabelsByDefault

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.app.util.opinion.Loader

compareTo, loadsIntoNewFolder, supportsLoadIntoProgram

Field Details

XML_SRC_NAME

public static final String XML_SRC_NAME

See Also:

• Constant Field Values

Constructor Details

XmlLoader

public XmlLoader()

Method Details

getTier

public LoaderTier getTier()

Description copied from interface: Loader

For ordering purposes; lower tier numbers are more important (and listed first).

Returns:

the tier of the loader

getTierPriority

public int getTierPriority()

Description copied from interface: Loader

For ordering purposes; lower numbers are more important (and listed first, within its tier).

Returns:

the ordering of the loader within its tier

supportsLoadIntoProgram

public boolean supportsLoadIntoProgram()

Description copied from interface: Loader

Checks to see if this Loader supports loading into an existing Program.

The default behavior of this method is to return false.

Returns:

True if this Loader supports loading into an existing Program; otherwise, false.

findSupportedLoadSpecs

public Collection<LoadSpec> findSupportedLoadSpecs(ByteProvider provider)
                                            throws IOException

Description copied from interface: Loader

If this Loader supports loading the given ByteProvider, this methods returns a Collection of all supported LoadSpecs that contain discovered load specification information that this Loader will need to load. If this Loader cannot support loading the given ByteProvider, an empty Collection is returned.

Parameters:

provider - The bytes being loaded.

Returns:

A Collection of LoadSpecs that this Loader supports loading, or an empty Collection if this Loader doesn't support loading the given ByteProvider.

Throws:

IOException - if there was an IO-related issue finding the LoadSpecs.

getPreferredFileName

public String getPreferredFileName(ByteProvider provider)

Description copied from interface: Loader

The preferred file name to use when loading.

The default behavior of this method is to return the (cleaned up) name of the given ByteProvider.

NOTE: This method may get called frequently, so only parse the given ByteProvider if absolutely necessary.

Parameters:

provider - The bytes to load.

Returns:

The preferred file name to use when loading.

loadProgram

protected List<Loaded<Program>> loadProgram(ByteProvider provider,
 String programName,
 Project project,
 String programFolderPath,
 LoadSpec loadSpec,
 List<Option> options,
 MessageLog log,
 Object consumer,
 TaskMonitor monitor)
                                     throws IOException,
LoadException,
CancelledException

Description copied from class: AbstractProgramLoader

Loads bytes in a particular format as a new Loaded Program. Multiple Programs may end up getting created, depending on the nature of the format.

Note that when the load completes, the returned Loaded Programs are not saved to a project. That is the responsibility of the caller (see Loaded.save(Project, MessageLog, TaskMonitor)).

It is also the responsibility of the caller to release the returned Loaded Programs with Loaded.release(Object) when they are no longer needed.

Specified by:

loadProgram in class AbstractProgramLoader

Parameters:

provider - The bytes to load.

programName - A suggested name for the primary Loaded Program. This is just a suggestion, and a Loader implementation reserves the right to change it. The Loaded Programs should be queried for their true names using Loaded.getName().

project - The Project. Loaders can use this to take advantage of existing DomainFolders and DomainFiles to do custom behaviors such as loading libraries. Could be null if there is no project.

programFolderPath - A suggested project folder path for the Loaded Programs. This is just a suggestion, and a Loader implementation reserves the right to change it for each Loaded result. The Loaded Programs should be queried for their true project folder paths using Loaded.getProjectFolderPath().

loadSpec - The LoadSpec to use during load.

options - The load options.

log - The message log.

consumer - A consumer object for generated Programs.

monitor - A task monitor.

Returns:

A List of one or more Loaded Programs (created but not saved).

Throws:

IOException - if there was an IO-related problem loading.

LoadException - if the load failed in an expected way.

CancelledException - if the user cancelled the load.

loadProgramInto

protected void loadProgramInto(ByteProvider provider,
 LoadSpec loadSpec,
 List<Option> options,
 MessageLog log,
 Program prog,
 TaskMonitor monitor)
                        throws IOException,
LoadException,
CancelledException

Description copied from class: AbstractProgramLoader

Loads program bytes into the specified Program. This method will not create any new Programs. It is only for adding to an existing Program.

NOTE: The loading that occurs in this method will automatically be done in a transaction.

Specified by:

loadProgramInto in class AbstractProgramLoader

Parameters:

provider - The bytes to load into the Program.

loadSpec - The LoadSpec to use during load.

options - The load options.

log - The message log.

prog - The Program to load into.

monitor - A cancelable task monitor.

Throws:

IOException - if there was an IO-related problem loading.

LoadException - if the load failed in an expected way.

CancelledException - if the user cancelled the load.

getDefaultOptions

public List<Option> getDefaultOptions(ByteProvider provider,
 LoadSpec loadSpec,
 DomainObject domainObject,
 boolean loadIntoProgram)

Description copied from interface: Loader

Gets the default Loader options.

Specified by:

getDefaultOptions in interface Loader

Overrides:

getDefaultOptions in class AbstractProgramLoader

Parameters:

provider - The bytes of the thing being loaded.

loadSpec - The LoadSpec.

domainObject - The DomainObject being loaded.

loadIntoProgram - True if the load is adding to an existing DomainObject; otherwise, false.

Returns:

A list of the Loader's default options.

getName

public String getName()

Description copied from interface: Loader

Gets the Loader's name, which is used both for display purposes, and to identify the Loader in the opinion files.

Returns:

The Loader's name.

validateOptions

public String validateOptions(ByteProvider provider,
 LoadSpec loadSpec,
 List<Option> options,
 Program program)

Description copied from interface: Loader

Validates the Loader's options and returns null if all options are valid; otherwise, an error message describing the problem is returned.

Specified by:

validateOptions in interface Loader

Overrides:

validateOptions in class AbstractProgramLoader

Parameters:

provider - The bytes of the thing being loaded.

loadSpec - The proposed LoadSpec.

options - The list of Options to validate.

program - existing program if the loader is adding to an existing program. If it is a fresh import, then this will be null.

Returns:

null if all Options are valid; otherwise, an error message describing the problem is returned.