Package ghidra.app.util.exporter

Class OriginalFileExporter

java.lang.Object

ghidra.app.util.exporter.Exporter

ghidra.app.util.exporter.ProgramExporter

ghidra.app.util.exporter.OriginalFileExporter

All Implemented Interfaces:

ExtensionPoint

public class OriginalFileExporter
extends ProgramExporter

An Exporter that can export the originally imported file.

WARNING: Programs written to disk with this exporter may be runnable on your native platform. Use caution when exporting potentially malicious programs.

Field Summary

Fields inherited from class ghidra.app.util.exporter.Exporter

EMPTY_OPTIONS, log, provider

Constructor Summary

Constructors

Change	Constructor	Description
	OriginalFileExporter()	Creates a new OriginalFileExporter

Method Summary

Change	Modifier and Type	Method	Description
	boolean	canExportDomainObject(DomainObject domainObject)	Returns true if this exporter knows how to export the given domain object considering any constraints based on the specific makeup of the object.
	boolean	canExportDomainObject(Class<? extends DomainObject> domainObjectClass)	Returns true if this exporter is capable of exporting the given domain file/object content type.
	boolean	export(File file, DomainObject domainObj, AddressSetView addrSet, TaskMonitor monitor)	Actually does the work of exporting a DomainObject.
	List<Option>	getOptions(DomainObjectService domainObjectService)	Returns the available options for this exporter.
	void	setOptions(List<Option> opt)	Sets the options.
	boolean	supportsAddressRestrictedExport()	Returns true if this exporter can perform a restricted export of a DomainObject based upon a specified AddressSetView.

Methods inherited from class ghidra.app.util.exporter.ProgramExporter

getProgram

Methods inherited from class ghidra.app.util.exporter.Exporter

canExportDomainFile, export, getDefaultFileExtension, getHelpLocation, getMessageLog, getName, setExporterServiceProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Details

OriginalFileExporter

public OriginalFileExporter()

Creates a new OriginalFileExporter

Method Details

supportsAddressRestrictedExport

public boolean supportsAddressRestrictedExport()

Description copied from class: Exporter

Returns true if this exporter can perform a restricted export of a DomainObject based upon a specified AddressSetView.

Overrides:

supportsAddressRestrictedExport in class Exporter

Returns:

true if this exporter can export less than the entire domain file.

canExportDomainObject

public boolean canExportDomainObject(Class<? extends DomainObject> domainObjectClass)

Description copied from class: Exporter

Returns true if this exporter is capable of exporting the given domain file/object content type. For example, some exporters have the ability to export programs, other exporters can export other DomainFile or DomainObject types such as project data type archives.

NOTE: This method should only be used as a preliminary check, if necessary, to identify exporter implementations that are capable of handling a specified content type/class. Prior to export a final check should be performed based on the export or either a DomainFile or DomainObject:

DomainFile export - the method Exporter.canExportDomainFile(DomainFile) should be used to verify a direct project file export is possible using the Exporter.export(File, DomainFile, TaskMonitor) method which may avoid opening the file first.

DomainObject export - the method Exporter.canExportDomainObject(DomainObject) should be used to verify an export of a specific object is possible before using the Exporter.export(File, DomainObject, AddressSetView, TaskMonitor) method.

Overrides:

canExportDomainObject in class ProgramExporter

Parameters:

domainObjectClass - the class of the domain object to test for exporting.

Returns:

true if this exporter knows how to export the given domain object type.

canExportDomainObject

public boolean canExportDomainObject(DomainObject domainObject)

Description copied from class: Exporter

Returns true if this exporter knows how to export the given domain object considering any constraints based on the specific makeup of the object. This method should be used prior to exporting using the Exporter.export(File, DomainObject, AddressSetView, TaskMonitor) method.

Overrides:

canExportDomainObject in class Exporter

Parameters:

domainObject - the domain object to test for exporting.

Returns:

true if this exporter knows how to export the given domain object.

export

public boolean export(File file,
 DomainObject domainObj,
 AddressSetView addrSet,
 TaskMonitor monitor)
               throws IOException,
ExporterException

Description copied from class: Exporter

Actually does the work of exporting a DomainObject. Export will include all saved and unsaved modifications which may have been made to the object.

Specified by:

export in class Exporter

Parameters:

file - the output file to write the exported info

domainObj - the domain object to export

addrSet - the address set if only a portion of the program should be exported NOTE: see Exporter.supportsAddressRestrictedExport().

monitor - the task monitor

Returns:

true if the program was successfully exported; otherwise, false. If the program was not successfully exported, the message log should be checked to find the source of the error.

Throws:

IOException - if an IO error occurs

ExporterException - if export error occurs

getOptions

public List<Option> getOptions(DomainObjectService domainObjectService)

Description copied from class: Exporter

Returns the available options for this exporter. The program is needed because some exporters may have options that vary depending on the specific program being exported.

Specified by:

getOptions in class Exporter

Parameters:

domainObjectService - a service for retrieving the applicable domainObject.

Returns:

the available options for this exporter

setOptions

public void setOptions(List<Option> opt)

Description copied from class: Exporter

Sets the options. This method is not for defining the options, but rather it is for setting the values of options. If invalid options are passed in, then OptionException should be thrown.

Specified by:

setOptions in class Exporter

Parameters:

opt - the option values for this exporter