Package ghidra.framework.model

Interface ToolServices

All Known Implementing Classes:

ToolServicesAdapter

public interface ToolServices

Services that the Tool uses.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_TOOLNAME	The default tool name for Ghidra

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(Tool tool)	Returns true if this tool should be saved base on the state of other runnings instances of the same tool
void	closeTool(Tool tool)	Notify the framework that the tool is closing.
void	displaySimilarTool(Tool tool, DomainFile domainFile, PluginEvent event)	Find a running tool like the one specified that has the named domain file.
java.io.File	exportTool(ToolTemplate tool)	Save the tool to the given location on the local file system.
java.util.Set<ToolTemplate>	getCompatibleTools(java.lang.Class<? extends DomainObject> domainClass)	Returns a set of tools that can open the given domain file class.
java.util.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.
Tool[]	getRunningTools()	Return array of running tools
ToolChest	getToolChest()	Get the tool chest for the project.
Tool	launchDefaultTool(DomainFile domainFile)	Launch the default tool; if domainFile is not null, this file will be opened in the tool.
Tool	launchTool(java.lang.String toolName, DomainFile domainFile)	Launch the tool with the given name
void	removeDefaultToolChangeListener(DefaultToolChangeListener listener)	Remove the listener.
void	saveTool(Tool tool)	Saves the tool's configuration in the standard tool location.
void	setContentTypeToolAssociations(java.util.Set<ToolAssociationInfo> infos)	Sets the associations, which describe content types and the tools used to open them, for the system.

Field Detail

DEFAULT_TOOLNAME

static final java.lang.String DEFAULT_TOOLNAME

The default tool name for Ghidra

See Also:

Constant Field Values

Method Detail

closeTool

void closeTool(Tool tool)

Notify the framework that the tool is closing.

Parameters:

tool - tool that is closing

saveTool

void saveTool(Tool tool)

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

Parameters:

tool - tool to save.

exportTool

java.io.File exportTool(ToolTemplate tool)
                 throws java.io.FileNotFoundException,
                        java.io.IOException

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

Parameters:

tool - the tool template to write

Returns:

the file to which the tool was saved

Throws:

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

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

getToolChest

ToolChest getToolChest()

Get the tool chest for the project.

displaySimilarTool

void displaySimilarTool(Tool tool,
                        DomainFile domainFile,
                        PluginEvent event)

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.

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

getDefaultToolTemplate

ToolTemplate getDefaultToolTemplate(DomainFile domainFile)

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.

Parameters:

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

Returns:

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

getCompatibleTools

java.util.Set<ToolTemplate> getCompatibleTools(java.lang.Class<? extends DomainObject> domainClass)

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

Parameters:

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

getContentTypeToolAssociations

java.util.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.

See Also:

setContentTypeToolAssociations(Set)

setContentTypeToolAssociations

void setContentTypeToolAssociations(java.util.Set<ToolAssociationInfo> infos)

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

Parameters:

infos - The associations to be applied

See Also:

getContentTypeToolAssociations()

launchDefaultTool

Tool launchDefaultTool(DomainFile domainFile)

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

Parameters:

domainFile - the file to open; may be null

See Also:

#setDefaultTool(ToolTemplate)

launchTool

Tool launchTool(java.lang.String toolName,
                DomainFile domainFile)

Launch the tool with the given name

Parameters:

toolName - name of the tool to launch

domainFile - the file to open; may be null

addDefaultToolChangeListener

void addDefaultToolChangeListener(DefaultToolChangeListener listener)

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

removeDefaultToolChangeListener

void removeDefaultToolChangeListener(DefaultToolChangeListener listener)

Remove the listener.

getRunningTools

Tool[] getRunningTools()

Return array of running tools

Returns:

array of Tools

canAutoSave

boolean canAutoSave(Tool tool)

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

Parameters:

tool - the tool to check for saving

Returns:

true if the tool should be saved