Package ghidra.app.util.opinion

Class DecompileDebugXmlLoader

java.lang.Object

ghidra.app.util.opinion.AbstractProgramLoader

ghidra.app.util.opinion.DecompileDebugXmlLoader

All Implemented Interfaces:

Loader, ExtensionPoint, Comparable<Loader>

public class DecompileDebugXmlLoader
extends AbstractProgramLoader

Loader for handling XML files generated by the Decompiler on the central function that was in the Decompiler pane when the Debug Function Decompilation feature in the Decompiler is used. Reference @DecompileDebug.java for the generation of the XML file.

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.app.util.opinion.Loader

Loader.ImporterSettings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DECOMPILER_DEBUG_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
DecompileDebugXmlLoader()

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.
String	getName()	Gets the Loader's name, which is used both for display purposes, and to identify the Loader in the opinion files.
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(Loader.ImporterSettings settings)	After initial parsing of the XML file, load the details into a new program for loading/viewing in Ghidra.
protected void	loadProgramInto(Program program, Loader.ImporterSettings settings)	Loads program bytes into the specified Program.

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

addExternalBlock, createDefaultMemoryBlocks, createProgram, createProgram, generateBlockName, getDefaultOptions, getLanguageService, load, loadInto, markAsFunction, postLoadCleanup, postLoadProgramFixups, setProgramProperties, shouldApplyProcessorLabelsByDefault, validateOptions

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, getPreferredFileName, loadsIntoNewFolder, supportsLoadIntoProgram, supportsLoadIntoProgram

Field Details

DECOMPILER_DEBUG_SRC_NAME

public static final String DECOMPILER_DEBUG_SRC_NAME

See Also:

• Constant Field Values

Constructor Details

DecompileDebugXmlLoader

public DecompileDebugXmlLoader()

Method Details

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.

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

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.

loadProgram

protected List<Loaded<Program>> loadProgram(Loader.ImporterSettings settings)
                                     throws IOException,
CancelledException

After initial parsing of the XML file, load the details into a new program for loading/viewing in Ghidra. 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(TaskMonitor)).

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

Specified by:

loadProgram in class AbstractProgramLoader

Parameters:

settings - The Loader.ImporterSettings.

Returns:

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

Throws:

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

CancelledException - if the user cancelled the load.

loadProgramInto

protected void loadProgramInto(Program program,
 Loader.ImporterSettings settings)
                        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:

program - The Program to load into.

settings - The Loader.ImporterSettings.

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.