Package ghidra.app.script

Class GhidraScriptProvider

java.lang.Object

ghidra.app.script.GhidraScriptProvider

All Implemented Interfaces:

ExtensionPoint, java.lang.Comparable<GhidraScriptProvider>

Direct Known Subclasses:

JavaScriptProvider, PythonScriptProvider

public abstract class GhidraScriptProvider
extends java.lang.Object
implements ExtensionPoint, java.lang.Comparable<GhidraScriptProvider>

NOTE: ALL GhidraScriptProvider CLASSES MUST END IN "ScriptProvider". If not, the ClassSearcher will not find them.

Constructor Summary

Constructors

Change	Constructor	Description
GhidraScriptProvider()

Method Summary

Change	Modifier and Type	Method	Description
	int	compareTo(GhidraScriptProvider that)
	abstract void	createNewScript(ResourceFile newScript, java.lang.String category)	Creates a new script using the specified file.
	boolean	deleteScript(ResourceFile scriptSource)	Deletes the script file and unloads the script from the script manager.
	boolean	equals(java.lang.Object obj)
NEW	protected java.lang.String	fixupName(java.lang.String scriptName)	Deprecated.
NEW	protected java.lang.String	getCertificationBodyPrefix()	Return the prefix for each certification header bofy line if this file is subject to certification
NEW	protected java.lang.String	getCertifyHeaderEnd()	Return the end of certification header line if this file type is subject to certification.
NEW	protected java.lang.String	getCertifyHeaderStart()	Return the start of certification header line if this file type is subject to certification.
	abstract java.lang.String	getCommentCharacter()	Returns the comment character.
	abstract java.lang.String	getDescription()	Returns a description for this type of script.
	abstract java.lang.String	getExtension()	Returns the file extension for this type of script.
	abstract GhidraScript	getScriptInstance(ResourceFile sourceFile, java.io.PrintWriter writer)	Returns a GhidraScript instance for the specified source file.
	int	hashCode()
	java.lang.String	toString()
	protected void	writeBody(java.io.PrintWriter writer)	Writes the script body template.
	protected void	writeHeader(java.io.PrintWriter writer, java.lang.String category)	Writes the script header.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GhidraScriptProvider

public GhidraScriptProvider()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(GhidraScriptProvider that)

Specified by:

compareTo in interface java.lang.Comparable<GhidraScriptProvider>

deleteScript

public boolean deleteScript(ResourceFile scriptSource)

Deletes the script file and unloads the script from the script manager.

Parameters:

scriptSource - the script source file

Returns:

true if the script was completely deleted and cleaned up

getDescription

public abstract java.lang.String getDescription()

Returns a description for this type of script.

Returns:

a description for this type of script

getExtension

public abstract java.lang.String getExtension()

Returns the file extension for this type of script. For example, ".java" or ".py".

Returns:

the file extension for this type of script

getScriptInstance

public abstract GhidraScript getScriptInstance(ResourceFile sourceFile,
                                               java.io.PrintWriter writer)
                                        throws java.lang.ClassNotFoundException,
                                               java.lang.InstantiationException,
                                               java.lang.IllegalAccessException

Returns a GhidraScript instance for the specified source file.

Parameters:

sourceFile - the source file

writer - the print writer to write warning/error messages

Returns:

a GhidraScript instance for the specified source file

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

createNewScript

public abstract void createNewScript(ResourceFile newScript,
                                     java.lang.String category)
                              throws java.io.IOException

Creates a new script using the specified file.

Parameters:

newScript - the new script file

category - the script category

Throws:

java.io.IOException - if an error occurs writing the file

getCommentCharacter

public abstract java.lang.String getCommentCharacter()

Returns the comment character. For example, "//" or "#".

Returns:

the comment character

writeHeader

protected void writeHeader(java.io.PrintWriter writer,
                           java.lang.String category)

Writes the script header. Include a place holder for each meta-data item.

Parameters:

writer - the print writer

category - the default category

writeBody

protected void writeBody(java.io.PrintWriter writer)

Writes the script body template.

Parameters:

writer - the print writer

fixupName NEW

@Deprecated
protected java.lang.String fixupName(java.lang.String scriptName)

Deprecated.

Fixup a script name for searching in script directories.

This method is part of a poorly specified behavior that is due for future amendment, see GhidraScriptUtil.fixupName(String).

Parameters:

scriptName - the name of the script, must end with this provider's extension

Returns:

a (relative) file path to the corresponding script

getCertifyHeaderStart NEW

protected java.lang.String getCertifyHeaderStart()

Return the start of certification header line if this file type is subject to certification.

Returns:

start of certification header or null if not supported

getCertificationBodyPrefix NEW

protected java.lang.String getCertificationBodyPrefix()

Return the prefix for each certification header bofy line if this file is subject to certification

Returns:

certification heaber body prefix or null if not supported

getCertifyHeaderEnd NEW

protected java.lang.String getCertifyHeaderEnd()

Return the end of certification header line if this file type is subject to certification.

Returns:

end of certification header or null if not supported