Package ghidra.framework.project.tool

Class GhidraTool

java.lang.Object

docking.AbstractDockingTool

ghidra.framework.plugintool.PluginTool

ghidra.framework.project.tool.GhidraTool

All Implemented Interfaces:

Tool, ServiceProvider

Direct Known Subclasses:

TestTool

public class GhidraTool
extends PluginTool

Tool created by the workspace when the user chooses to create a new tool. Its ToolConfigProvider shows all Plugins with the exception of those plugins that can be added to the Front End tool only.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	autoSave
static java.lang.String	EXTENSIONS_PREFERENCE_NAME

Fields inherited from class ghidra.framework.plugintool.PluginTool

DESCRIPTION_PROPERTY_NAME, extensionTableProvider, ICON_PROPERTY_NAME, iconURL, isDisposed, manageDialog, PLUGIN_COUNT_PROPERTY_NAME, TOOL_NAME_PROPERTY, toolName

Fields inherited from class docking.AbstractDockingTool

configChangedFlag, optionsMap, toolActions, winMgr

Constructor Summary

Constructors

Constructor	Description
GhidraTool(Project project, GhidraToolTemplate template)	Construct a new GhidraTool using an existing template.
GhidraTool(Project project, java.lang.String name)	Construct a new Ghidra Tool.

Method Summary

Modifier and Type	Method	Description
protected void	addManagePluginsAction()
void	checkForNewExtensions()	Looks for extensions that have been installed since the last time this tool was launched.
protected DockingWindowManager	createDockingWindowManager(boolean isDockable, boolean hasStatus, boolean isModal)	This method exists here, as opposed to inline in the constructor, so that subclasses can alter the behavior of the DockingWindowManager construction.
protected boolean	doSaveTool()	Called when it is time to save the tool.
void	exit()
PluginClassManager	getPluginClassManager()
ToolTemplate	getToolTemplate(boolean includeConfigState)
protected void	initActions()	Placeholder for subclasses to get a chance to install actions before plugins.
void	restoreWindowingDataFromXml(org.jdom.Element rootElement)
org.jdom.Element	saveWindowingDataToXml()
void	setToolName(java.lang.String name)
boolean	shouldSave()
protected void	showConfig()

Methods inherited from class ghidra.framework.plugintool.PluginTool

acceptDomainFiles, addEventListener, addExitAction, addExportToolAction, addHelpActions, addListenerForAllPluginEvents, addOptionsAction, addPlugin, addPlugin, addPlugins, addPropertyChangeListener, addSaveToolAction, addServiceListener, addStatusComponent, addToolListener, beep, cancelCurrentTask, canClose, canCloseDomainFile, canCloseDomainObject, clearLastEvents, close, contextChanged, dispose, execute, execute, execute, executeBackgroundCommand, firePluginEvent, getActiveComponentProvider, getActiveWindow, getConsumedToolEventNames, getDefaultToolContext, getDomainFiles, getIcon, getIconURL, getInstanceName, getLocation, getManagedPlugins, getManagePluginsDialog, getName, getOptions, getOptions, getProject, getProjectManager, getService, getServices, getSize, getSupportedDataTypes, getToolEventNames, getToolName, getToolServices, getTransientState, getUndoRedoToolState, hasOptions, hasToolListeners, hasUnsavedData, installHomeButton, isConfigurable, isExecutingCommand, isService, isWindowsOnTop, optionsChanged, prepareToSave, processToolEvent, putInstanceName, refreshKeybindings, registerOptionsNameChange, removeEventListener, removeListenerForAllPluginEvents, removePlugins, removePreferenceState, removePropertyChangeListener, removeServiceListener, removeStatusComponent, removeToolListener, restoreDataStateFromXml, restoreFromXml, restoreOptionsFromXml, restorePluginsFromXml, saveDataStateToXml, saveTool, saveToolAs, saveToolToToolTemplate, saveToXml, scheduleFollowOnCommand, setConfigChanged, setDefaultComponent, setIconURL, setLocation, setProject, setSize, setSubTitle, setUnconfigurable, setWindowsOnTop, showComponentHeader, showConfig, showDialog, showDialog, showDialogOnActiveWindow, showEditWindow, showExtensions, terminateBackgroundCommands, threadIsBackgroundTaskThread

Methods inherited from class docking.AbstractDockingTool

addAction, addComponentProvider, addContextListener, addLocalAction, addPopupActionProvider, clearStatusInfo, getAllActions, getComponentProvider, getDockingActionsByOwnerName, getProviderWindow, getToolActions, getToolFrame, getWindowManager, hasConfigChanged, isActive, isVisible, isVisible, removeAction, removeComponentProvider, removeContextListener, removeLocalAction, removePopupActionProvider, setMenuGroup, setMenuGroup, setStatusInfo, setStatusInfo, setVisible, showComponentProvider, showDialog, toFront, toFront, updateTitle

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSIONS_PREFERENCE_NAME

public static final java.lang.String EXTENSIONS_PREFERENCE_NAME

See Also:

Constant Field Values

autoSave

public static boolean autoSave

Constructor Detail

GhidraTool

public GhidraTool(Project project,
                  java.lang.String name)

Construct a new Ghidra Tool.

Parameters:

project - the project associated with the tool

name - the name of the tool

GhidraTool

public GhidraTool(Project project,
                  GhidraToolTemplate template)

Construct a new GhidraTool using an existing template.

Parameters:

project - project that is the associated with the tool.

template - the template to use when creating the tool

Method Detail

createDockingWindowManager

protected DockingWindowManager createDockingWindowManager(boolean isDockable,
                                                          boolean hasStatus,
                                                          boolean isModal)

Description copied from class: PluginTool

This method exists here, as opposed to inline in the constructor, so that subclasses can alter the behavior of the DockingWindowManager construction.

Overrides:

createDockingWindowManager in class PluginTool

Parameters:

isDockable - true if the tool contains components that can be docked

hasStatus - true if the tool should display a status component

isModal - true if the tool is modal, meaning that while this tool is visible, no other tool or dialog in Ghidra can have focus

Returns:

a new DockingWindowManager

initActions

protected void initActions()

Description copied from class: PluginTool

Placeholder for subclasses to get a chance to install actions before plugins.

Overrides:

initActions in class PluginTool

getPluginClassManager

public PluginClassManager getPluginClassManager()

Specified by:

getPluginClassManager in class PluginTool

setToolName

public void setToolName(java.lang.String name)

Overrides:

setToolName in class PluginTool

getToolTemplate

public ToolTemplate getToolTemplate(boolean includeConfigState)

Overrides:

getToolTemplate in class PluginTool

saveWindowingDataToXml

public org.jdom.Element saveWindowingDataToXml()

Overrides:

saveWindowingDataToXml in class PluginTool

restoreWindowingDataFromXml

public void restoreWindowingDataFromXml(org.jdom.Element rootElement)

Overrides:

restoreWindowingDataFromXml in class PluginTool

shouldSave

public boolean shouldSave()

Overrides:

shouldSave in class PluginTool

doSaveTool

protected boolean doSaveTool()

Description copied from class: PluginTool

Called when it is time to save the tool. Handles auto-saving logic.

Overrides:

doSaveTool in class PluginTool

Returns:

true if a save happened

exit

public void exit()

Overrides:

exit in class PluginTool

addManagePluginsAction

protected void addManagePluginsAction()

showConfig

protected void showConfig()

checkForNewExtensions

public void checkForNewExtensions()

Looks for extensions that have been installed since the last time this tool was launched. If any are found, and if those extensions contain plugins, the user is notified and given the chance to install them.