Package ghidra

Class GhidraTestApplicationLayout

java.lang.Object

utility.application.ApplicationLayout

ghidra.GhidraApplicationLayout

ghidra.GhidraTestApplicationLayout

public class GhidraTestApplicationLayout
extends GhidraApplicationLayout

The Ghidra test application layout defines the customizable elements of the Ghidra application's directory structure when running a test.

This layout exists because tests often need to provide their own user settings directory, rather than using Ghidra's default.

Field Summary

Fields inherited from class utility.application.ApplicationLayout

applicationInstallationDir, applicationProperties, applicationRootDirs, extensionArchiveDir, extensionInstallationDirs, modules, patchDir, userCacheDir, userSettingsDir, userTempDir

Constructor Summary

Constructors

Constructor	Description
GhidraTestApplicationLayout(java.io.File userSettingsDir)	Constructs a new Ghidra application layout object with the provided user settings directory.

Method Summary

Modifier and Type	Method	Description
protected ResourceFile	findExtensionArchiveDirectory()	Returns the directory where all Ghidra extension archives are stored.
protected java.util.List<ResourceFile>	findExtensionInstallationDirectories()	Returns a prioritized list of directories where Ghidra extensions are installed.
protected ResourceFile	findPatchDirectory()	Returns the directory that allows users to add jar and class files to override existing distribution files

Methods inherited from class ghidra.GhidraApplicationLayout

findGhidraApplicationInstallationDir, findGhidraApplicationRootDirs, findGhidraModules

Methods inherited from class utility.application.ApplicationLayout

createUserDirs, getApplicationInstallationDir, getApplicationProperties, getApplicationRootDirs, getExtensionArchiveDir, getExtensionInstallationDirs, getModules, getPatchDir, getUserCacheDir, getUserSettingsDir, getUserTempDir, inSingleJarMode

Methods inherited from class java.lang.Object

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

Constructor Detail

GhidraTestApplicationLayout

public GhidraTestApplicationLayout(java.io.File userSettingsDir)
                            throws java.io.FileNotFoundException,
                                   java.io.IOException

Constructs a new Ghidra application layout object with the provided user settings directory.

This layout is useful when running Ghidra tests.

Parameters:

userSettingsDir - The custom user settings directory to use.

Throws:

java.io.FileNotFoundException - if there was a problem getting a user directory.

java.io.IOException - if there was a problem getting the application properties.

Method Detail

findExtensionArchiveDirectory

protected ResourceFile findExtensionArchiveDirectory()

Description copied from class: GhidraApplicationLayout

Returns the directory where all Ghidra extension archives are stored. This should be at the following location:

• [application root]/Extensions/Ghidra

Overrides:

findExtensionArchiveDirectory in class GhidraApplicationLayout

Returns:

the archive folder, or null if can't be determined

findExtensionInstallationDirectories

protected java.util.List<ResourceFile> findExtensionInstallationDirectories()

Description copied from class: GhidraApplicationLayout

Returns a prioritized list of directories where Ghidra extensions are installed. These should be at the following locations:

• [user settings dir]/Extensions
• [application install dir]/Ghidra/Extensions
• ghidra/Ghidra/Extensions (development mode)

Overrides:

findExtensionInstallationDirectories in class GhidraApplicationLayout

Returns:

the install folder, or null if can't be determined

findPatchDirectory

protected ResourceFile findPatchDirectory()

Description copied from class: GhidraApplicationLayout

Returns the directory that allows users to add jar and class files to override existing distribution files

Overrides:

findPatchDirectory in class GhidraApplicationLayout

Returns:

the patch dir; null if not in a distribution