Package ghidra.framework.plugintool

Class ToolServicesAdapter

java.lang.Object

ghidra.framework.plugintool.ToolServicesAdapter

All Implemented Interfaces:

ToolServices

public class ToolServicesAdapter
extends Object
implements ToolServices

Field Summary

Fields inherited from interface ghidra.framework.model.ToolServices

DEFAULT_TOOLNAME

Constructor Summary

Constructors

Constructor	Description
ToolServicesAdapter()

Method Summary

Modifier and Type	Method	Description
void	addDefaultToolChangeListener(DefaultToolChangeListener listener)	Add a listener that will be notified when the default tool specification changes
boolean	canAutoSave(PluginTool tool)	Returns true if this tool should be saved base on the state of other running instances of the same tool
void	closeTool(PluginTool tool)	Notify the framework that the tool is closing.
void	displaySimilarTool(PluginTool tool, DomainFile domainFile, PluginEvent event)	Find a running tool like the one specified that has the named domain file.
File	exportTool(ToolTemplate tool)	Save the tool to the given location on the local file system.
Set<ToolTemplate>	getCompatibleTools(Class<? extends DomainObject> domainClass)	Returns a set of tools that can open the given domain file class.
Set<ToolAssociationInfo>	getContentTypeToolAssociations()	Returns the associations, which describe content types and the tools used to open them, for all content types known to the system.
ToolTemplate	getDefaultToolTemplate(DomainFile domainFile)	Returns the default tool template used to open the tool.
PluginTool[]	getRunningTools()	Return array of running tools
ToolChest	getToolChest()	Get the tool chest for the project
PluginTool	launchDefaultTool(DomainFile domainFile)	Launch the default tool; if domainFile is not null, this file will be opened in the tool.
PluginTool	launchTool(String toolName, DomainFile domainFile)	Launch the tool with the given name
void	removeDefaultToolChangeListener(DefaultToolChangeListener listener)	Remove the listener
void	saveTool(PluginTool tool)	Saves the tool's configuration in the standard tool location.
void	setContentTypeToolAssociations(Set<ToolAssociationInfo> infos)	Sets the associations, which describe content types and the tools used to open them, for the system.

Methods inherited from class java.lang.Object

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

Constructor Details

ToolServicesAdapter

public ToolServicesAdapter()

Method Details

addDefaultToolChangeListener

public void addDefaultToolChangeListener(DefaultToolChangeListener listener)

Description copied from interface: ToolServices

Add a listener that will be notified when the default tool specification changes

Specified by:

addDefaultToolChangeListener in interface ToolServices

Parameters:

listener - the listener

canAutoSave

public boolean canAutoSave(PluginTool tool)

Description copied from interface: ToolServices

Returns true if this tool should be saved base on the state of other running instances of the same tool

Specified by:

canAutoSave in interface ToolServices

Parameters:

tool - the tool to check for saving

Returns:

true if the tool should be saved

closeTool

public void closeTool(PluginTool tool)

Description copied from interface: ToolServices

Notify the framework that the tool is closing.

Specified by:

closeTool in interface ToolServices

Parameters:

tool - tool that is closing

displaySimilarTool

public void displaySimilarTool(PluginTool tool,
 DomainFile domainFile,
 PluginEvent event)

Description copied from interface: ToolServices

Find a running tool like the one specified that has the named domain file. If it finds a matching tool, then it is brought to the front. Otherwise, it creates one and runs it. It then invokes the specified event on the running tool.

Specified by:

displaySimilarTool in interface ToolServices

Parameters:

tool - find/create a tool like this one.

domainFile - open this file in the found/created tool.

event - invoke this event on the found/created tool

exportTool

public File exportTool(ToolTemplate tool)
                throws FileNotFoundException,
IOException

Description copied from interface: ToolServices

Save the tool to the given location on the local file system.

Specified by:

exportTool in interface ToolServices

Parameters:

tool - the tool template to write

Returns:

the file to which the tool was saved

Throws:

FileNotFoundException - thrown if the file's directory doesn't exist.

IOException - thrown if there is an error writing the file.

getCompatibleTools

public Set<ToolTemplate> getCompatibleTools(Class<? extends DomainObject> domainClass)

Description copied from interface: ToolServices

Returns a set of tools that can open the given domain file class.

Specified by:

getCompatibleTools in interface ToolServices

Parameters:

domainClass - The domain file class type for which to get tools

Returns:

the tools

getContentTypeToolAssociations

public Set<ToolAssociationInfo> getContentTypeToolAssociations()

Description copied from interface: ToolServices

Returns the associations, which describe content types and the tools used to open them, for all content types known to the system.

Specified by:

getContentTypeToolAssociations in interface ToolServices

Returns:

the associations

See Also:

• ToolServices.setContentTypeToolAssociations(Set)

getDefaultToolTemplate

public ToolTemplate getDefaultToolTemplate(DomainFile domainFile)

Description copied from interface: ToolServices

Returns the default tool template used to open the tool. Here default means the tool that should be used to open the given file, whether defined by the user or the system default.

Specified by:

getDefaultToolTemplate in interface ToolServices

Parameters:

domainFile - The file for which to find the preferred tool.

Returns:

The preferred tool that should be used to open the given file.

getRunningTools

public PluginTool[] getRunningTools()

Description copied from interface: ToolServices

Return array of running tools

Specified by:

getRunningTools in interface ToolServices

Returns:

array of Tools

getToolChest

public ToolChest getToolChest()

Description copied from interface: ToolServices

Get the tool chest for the project

Specified by:

getToolChest in interface ToolServices

Returns:

the tool chest

launchDefaultTool

public PluginTool launchDefaultTool(DomainFile domainFile)

Description copied from interface: ToolServices

Launch the default tool; if domainFile is not null, this file will be opened in the tool.

Specified by:

launchDefaultTool in interface ToolServices

Parameters:

domainFile - the file to open; may be null

Returns:

the tool

launchTool

public PluginTool launchTool(String toolName,
 DomainFile domainFile)

Description copied from interface: ToolServices

Launch the tool with the given name

Specified by:

launchTool in interface ToolServices

Parameters:

toolName - name of the tool to launch

domainFile - the file to open; may be null

Returns:

the tool

removeDefaultToolChangeListener

public void removeDefaultToolChangeListener(DefaultToolChangeListener listener)

Description copied from interface: ToolServices

Remove the listener

Specified by:

removeDefaultToolChangeListener in interface ToolServices

Parameters:

listener - the listener

saveTool

public void saveTool(PluginTool tool)

Description copied from interface: ToolServices

Saves the tool's configuration in the standard tool location.

Specified by:

saveTool in interface ToolServices

Parameters:

tool - tool to save.

setContentTypeToolAssociations

public void setContentTypeToolAssociations(Set<ToolAssociationInfo> infos)

Description copied from interface: ToolServices

Sets the associations, which describe content types and the tools used to open them, for the system.

Specified by:

setContentTypeToolAssociations in interface ToolServices

Parameters:

infos - The associations to be applied

See Also:

• ToolServices.getContentTypeToolAssociations()