Package ghidra.jython

Class JythonUtils

java.lang.Object

ghidra.jython.JythonUtils

public class JythonUtils
extends Object

Python utility method class.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JYTHON_CACHEDIR
static final String	JYTHON_NAME
static final String	JYTHON_SRC

Constructor Summary

Constructors

Constructor	Description
JythonUtils()

Method Summary

Modifier and Type	Method	Description
static File	setupJythonCacheDir(TaskMonitor monitor)	Sets up the jython cache directory.
static File	setupJythonHomeDir()	Sets up the jython home directory.

Methods inherited from class java.lang.Object

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

Field Details

JYTHON_NAME

public static final String JYTHON_NAME

See Also:

• Constant Field Values

JYTHON_CACHEDIR

public static final String JYTHON_CACHEDIR

See Also:

• Constant Field Values

JYTHON_SRC

public static final String JYTHON_SRC

See Also:

• Constant Field Values

Constructor Details

JythonUtils

public JythonUtils()

Method Details

setupJythonHomeDir

public static File setupJythonHomeDir()
                               throws IOException

Sets up the jython home directory. This is the directory that has the "Lib" directory in it.

Returns:

The jython home directory.

Throws:

IOException - If there was a disk-related problem setting up the home directory.

setupJythonCacheDir

public static File setupJythonCacheDir(TaskMonitor monitor)
                                throws CancelledException,
IOException

Sets up the jython cache directory. This is a temporary space that jython source files get compiled to and cached. It should NOT be in the Ghidra installation directory, because some installations will not have the appropriate directory permissions to create new files in.

Parameters:

monitor - A monitor to use during the cache directory setup.

Returns:

The jython cache directory.

Throws:

IOException - If there was a disk-related problem setting up the cache directory.

CancelledException - If the user cancelled the setup.