Package ghidra.framework

Class ToolUtils

java.lang.Object

ghidra.framework.ToolUtils

public class ToolUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TOOL_EXTENSION

Method Summary

Modifier and Type	Method	Description
static void	deleteTool(ToolTemplate template)
static java.util.Set<ToolTemplate>	getAllApplicationTools()	Returns all tools found in the classpath that live under a root 'defaultTools' directory or a root 'extraTools' directory
static java.lang.String	getApplicationToolDirPath()	Returns the user's personal tool chest directory path
static java.util.Set<ToolTemplate>	getDefaultApplicationTools()	Returns all tools found in the classpath that live under a root 'defaultTools' directory
static java.util.Set<ToolTemplate>	getExtraApplicationTools()	Returns all tools found in the classpath that live under a root 'extraTools' directory
static java.io.File	getToolFile(java.lang.String name)
static java.lang.String	getUniqueToolName(ToolTemplate template)
static java.io.File	getUserToolsDirectory()
static java.util.Map<java.lang.String,ToolTemplate>	loadUserTools()
static ToolTemplate	readToolTemplate(java.io.File toolFile)
static ToolTemplate	readToolTemplate(java.lang.String resourceFileName)
static void	removeInvalidPlugins(ToolTemplate template)
static void	renameToolTemplate(ToolTemplate toolTemplate, java.lang.String newName)
static boolean	writeToolTemplate(ToolTemplate template)

Methods inherited from class java.lang.Object

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

Field Detail

TOOL_EXTENSION

public static final java.lang.String TOOL_EXTENSION

See Also:

Constant Field Values

Method Detail

getUserToolsDirectory

public static java.io.File getUserToolsDirectory()

getDefaultApplicationTools

public static java.util.Set<ToolTemplate> getDefaultApplicationTools()

Returns all tools found in the classpath that live under a root 'defaultTools' directory

Returns:

the default tools

getExtraApplicationTools

public static java.util.Set<ToolTemplate> getExtraApplicationTools()

Returns all tools found in the classpath that live under a root 'extraTools' directory

Returns:

the extra tools

getAllApplicationTools

public static java.util.Set<ToolTemplate> getAllApplicationTools()

Returns all tools found in the classpath that live under a root 'defaultTools' directory or a root 'extraTools' directory

Returns:

the tools

loadUserTools

public static java.util.Map<java.lang.String,ToolTemplate> loadUserTools()

removeInvalidPlugins

public static void removeInvalidPlugins(ToolTemplate template)

deleteTool

public static void deleteTool(ToolTemplate template)

renameToolTemplate

public static void renameToolTemplate(ToolTemplate toolTemplate,
                                      java.lang.String newName)

writeToolTemplate

public static boolean writeToolTemplate(ToolTemplate template)

readToolTemplate

public static ToolTemplate readToolTemplate(java.io.File toolFile)

readToolTemplate

public static ToolTemplate readToolTemplate(java.lang.String resourceFileName)

getUniqueToolName

public static java.lang.String getUniqueToolName(ToolTemplate template)

getToolFile

public static java.io.File getToolFile(java.lang.String name)

getApplicationToolDirPath

public static java.lang.String getApplicationToolDirPath()

Returns the user's personal tool chest directory path

Returns:

the path