Class ComLoader

java.lang.Object

ghidra.app.util.opinion.AbstractProgramLoader

ghidra.app.util.opinion.AbstractLibrarySupportLoader

ghidra.app.util.opinion.ComLoader

All Implemented Interfaces:

Loader, ExtensionPoint, Comparable<Loader>

public class ComLoader
extends AbstractLibrarySupportLoader

A Loader for processing old-style DOS COM executables

Nested Class Summary

Nested classes/interfaces inherited from class AbstractLibrarySupportLoader

AbstractLibrarySupportLoader.LibrarySearchPath, AbstractLibrarySupportLoader.UnprocessedLibrary

Nested classes/interfaces inherited from interface Loader

Loader.ImporterSettings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COM_NAME

Fields inherited from class AbstractLibrarySupportLoader

DEPTH_OPTION_NAME, LIBRARY_DEST_FOLDER_OPTION_NAME, LIBRARY_SEARCH_PATH_DUMMY_OPTION_NAME, LINK_EXISTING_OPTION_NAME, LINK_SEARCH_FOLDER_OPTION_NAME, LOAD_LIBRARY_OPTION_NAME, LOAD_ONLY_LIBRARIES_OPTION_NAME, MIRROR_LAYOUT_OPTION_NAME

Fields inherited from class AbstractProgramLoader

ANCHOR_LABELS_OPTION_NAME, APPLY_LABELS_OPTION_NAME

Fields inherited from interface Loader

COMMAND_LINE_ARG_PREFIX, loggingDisabled, OPTIONS_PROJECT_SAVE_STATE_KEY

Constructor Summary

Constructors

Constructor	Description
ComLoader()

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.
Collection<String>	getAssociatedFileExtensions()	Returns a Collection of file extensions associated with this Loader.
String	getName()	Gets the Loader's name, which is used both for display purposes, and to identify the Loader in the opinion files.
boolean	isFallback()	Returns whether or not this is a "fallback" Loader.
protected void	load(Program program, Loader.ImporterSettings settings)	Loads bytes in a particular format into the given Program.

Methods inherited from class AbstractLibrarySupportLoader

createLibraryByteProvider, findLibraryInLoadedList, findLibraryInProject, getCustomLibrarySearchPaths, getDefaultOptions, getLibraryDestinationFolderPath, getLibraryDestinationSearchFolder, getLibraryLoadDepth, getLibraryNameComparator, getLibrarySearchFolders, getLibrarySearchPaths, getLinkSearchFolder, getRequiredLibraryProperty, getTier, getTierPriority, isLinkExistingLibraries, isLoadLibraries, isMirroredLayout, isValidSearchPath, loadProgram, loadProgramInto, lookupLibraryInFolder, lookupLibraryInFs, matchSupportedLoadSpec, matchSupportedLoadSpec, postLoadProgramFixups, processLibrary, shouldLoadOnlyLibraries, shouldSearchAllPaths, validateOptions

Methods inherited from class AbstractProgramLoader

createDefaultMemoryBlocks, createProgram, createProgram, generateBlockName, getLanguageService, load, loadInto, markAsFunction, markProperty, postLoadCleanup, setProgramProperties, shouldApplyProcessorLabelsByDefault

Methods inherited from class Object

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

Methods inherited from interface Loader

compareTo, createArg, getPreferredFileName, loadsIntoNewFolder, supportsLoadIntoProgram

Field Details

COM_NAME

public static final String COM_NAME

See Also:

• Constant Field Values

Constructor Details

ComLoader

public ComLoader()

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.

getAssociatedFileExtensions

public Collection<String> getAssociatedFileExtensions()

Description copied from interface: Loader

Returns a Collection of file extensions associated with this Loader.

Returns:

a Collection of file extensions associated with this Loader

isFallback

public boolean isFallback()

Description copied from interface: Loader

Returns whether or not this is a "fallback" Loader.

Fallback loaders are only considered during the import process if no other non-fallback loaders were compatible with the thing being imported.

Returns:

whether or not this is a "fallback" Loader

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.

load

protected void load(Program program,
 Loader.ImporterSettings settings)
             throws IOException,
CancelledException

Description copied from class: AbstractLibrarySupportLoader

Loads bytes in a particular format into the given Program.

Specified by:

load in class AbstractLibrarySupportLoader

Parameters:

program - The Program to load into.

settings - The Loader.ImporterSettings

Throws:

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

CancelledException - if the user cancelled the load.