Package ghidra.app.script

Class JythonStubScriptProvider

java.lang.Object

ghidra.app.script.GhidraScriptProvider

ghidra.app.script.AbstractPythonScriptProvider

ghidra.app.script.JythonStubScriptProvider

All Implemented Interfaces:

ExtensionPoint, Comparable<GhidraScriptProvider>

public class JythonStubScriptProvider NEW
extends AbstractPythonScriptProvider

A stub GhidraScriptProvider used to give feedback to a user trying to run a Jython script when the Jython Extension is not installed.

Uses a sub-default priority so the Jython Extension can get prioritized over this if it's installed.

Nested Class Summary

Nested Classes

Change	Modifier and Type	Class	Description
	static class	JythonStubScriptProvider.JythonStubException	A special type of GhidraScriptLoadException used to indicate that the Jython Extension is not installed.

Constructor Summary

Constructors

Change	Constructor	Description
	JythonStubScriptProvider()

Method Summary

Change	Modifier and Type	Method	Description
	String	getDescription()	Returns a description for this type of script.
	String	getRuntimeEnvironmentName()	Returns an optional runtime environment name of a GhidraScriptProvider that scripts can specify they require to run under.
	GhidraScript	getScriptInstance(ResourceFile sourceFile, PrintWriter writer)	Returns a GhidraScript instance for the specified source file.

Methods inherited from class ghidra.app.script.AbstractPythonScriptProvider

createNewScript, getBlockCommentEnd, getBlockCommentStart, getCertificationBodyPrefix, getCertifyHeaderEnd, getCertifyHeaderStart, getCommentCharacter, getExtension

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 Details

JythonStubScriptProvider

public JythonStubScriptProvider()

Method Details

getDescription

public String getDescription()

Description copied from class: GhidraScriptProvider

Returns a description for this type of script.

Specified by:

getDescription in class AbstractPythonScriptProvider

Returns:

a description for this type of script

getRuntimeEnvironmentName

public String getRuntimeEnvironmentName()

Description copied from class: GhidraScriptProvider

Returns an optional runtime environment name of a GhidraScriptProvider that scripts can specify they require to run under. Useful for when more than one GhidraScriptProvider uses the same file extension.

Specified by:

getRuntimeEnvironmentName in class AbstractPythonScriptProvider

Returns:

an optional runtime environment name of a GhidraScriptProvider that scripts can specify they require to run under (could be null if there is no requirement)

See Also:

• ScriptInfo.AT_RUNTIME

getScriptInstance

public GhidraScript getScriptInstance(ResourceFile sourceFile,
 PrintWriter writer)
                               throws JythonStubScriptProvider.JythonStubException

Description copied from class: GhidraScriptProvider

Returns a GhidraScript instance for the specified source file.

Specified by:

getScriptInstance in class AbstractPythonScriptProvider

Parameters:

sourceFile - the source file

writer - the print writer to write warning/error messages. If the error prevents success, throw an exception instead. The caller will print the error.

Returns:

a GhidraScript instance for the specified source file

Throws:

JythonStubScriptProvider.JythonStubException