Package ghidra.python

Class PythonScriptProvider

java.lang.Object

ghidra.app.script.GhidraScriptProvider

ghidra.python.PythonScriptProvider

All Implemented Interfaces:

ExtensionPoint, java.lang.Comparable<GhidraScriptProvider>

public class PythonScriptProvider
extends GhidraScriptProvider

Constructor Summary

Constructors

Constructor	Description
PythonScriptProvider()

Method Summary

Modifier and Type	Method	Description
void	createNewScript(ResourceFile newScript, java.lang.String category)	Creates a new script using the specified file.
java.util.regex.Pattern	getBlockCommentEnd()	Returns a Pattern that matches block comment closings.
java.util.regex.Pattern	getBlockCommentStart()	Returns a Pattern that matches block comment openings.
protected java.lang.String	getCertificationBodyPrefix()	Return the prefix for each certification header body line if this file is subject to certification.
protected java.lang.String	getCertifyHeaderEnd()	Return the end of certification header line if this file type is subject to certification.
protected java.lang.String	getCertifyHeaderStart()	Return the start of certification header line if this file type is subject to certification.
java.lang.String	getCommentCharacter()	Returns the comment character.
java.lang.String	getDescription()	Returns a description for this type of script.
java.lang.String	getExtension()	Returns the file extension for this type of script.
GhidraScript	getScriptInstance(ResourceFile sourceFile, java.io.PrintWriter writer)	Returns a GhidraScript instance for the specified source file.

Methods inherited from class ghidra.app.script.GhidraScriptProvider

compareTo, deleteScript, equals, fixupName, hashCode, toString, writeBody, writeHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

PythonScriptProvider

public PythonScriptProvider()

Method Detail

createNewScript

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

Description copied from class: GhidraScriptProvider

Creates a new script using the specified file.

Specified by:

createNewScript in class GhidraScriptProvider

Parameters:

newScript - the new script file

category - the script category

Throws:

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

getBlockCommentStart

public java.util.regex.Pattern getBlockCommentStart()

Returns a Pattern that matches block comment openings. In Python this is a triple single quote sequence, "'''".

Overrides:

getBlockCommentStart in class GhidraScriptProvider

Returns:

the Pattern for Python block comment openings

getBlockCommentEnd

public java.util.regex.Pattern getBlockCommentEnd()

Returns a Pattern that matches block comment closings. In Python this is a triple single quote sequence, "'''".

Overrides:

getBlockCommentEnd in class GhidraScriptProvider

Returns:

the Pattern for Python block comment openings

getCommentCharacter

public java.lang.String getCommentCharacter()

Description copied from class: GhidraScriptProvider

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

Specified by:

getCommentCharacter in class GhidraScriptProvider

Returns:

the comment character

getCertifyHeaderStart

protected java.lang.String getCertifyHeaderStart()

Description copied from class: GhidraScriptProvider

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

Overrides:

getCertifyHeaderStart in class GhidraScriptProvider

Returns:

start of certification header or null if not supported

getCertificationBodyPrefix

protected java.lang.String getCertificationBodyPrefix()

Description copied from class: GhidraScriptProvider

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

Overrides:

getCertificationBodyPrefix in class GhidraScriptProvider

Returns:

certification header body prefix or null if not supported

getCertifyHeaderEnd

protected java.lang.String getCertifyHeaderEnd()

Description copied from class: GhidraScriptProvider

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

Overrides:

getCertifyHeaderEnd in class GhidraScriptProvider

Returns:

end of certification header or null if not supported

getDescription

public java.lang.String getDescription()

Description copied from class: GhidraScriptProvider

Returns a description for this type of script.

Specified by:

getDescription in class GhidraScriptProvider

Returns:

a description for this type of script

getExtension

public java.lang.String getExtension()

Description copied from class: GhidraScriptProvider

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

Specified by:

getExtension in class GhidraScriptProvider

Returns:

the file extension for this type of script

getScriptInstance

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

Description copied from class: GhidraScriptProvider

Returns a GhidraScript instance for the specified source file.

Specified by:

getScriptInstance in class GhidraScriptProvider

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 - if the script class cannot be found

java.lang.InstantiationException - if the construction of the script fails for some reason

java.lang.IllegalAccessException - if the class constructor is not accessible