Package ghidra
Class GhidraJarApplicationLayout
java.lang.Object
utility.application.ApplicationLayout
ghidra.GhidraApplicationLayout
ghidra.GhidraJarApplicationLayout
The Ghidra jar application layout defines the customizable elements of the Ghidra application's
directory structure when running in "single jar mode."
-
Field Summary
Fields inherited from class utility.application.ApplicationLayout
applicationInstallationDir, applicationProperties, applicationRootDirs, extensionArchiveDir, extensionInstallationDirs, modules, patchDir, userCacheDir, userSettingsDir, userTempDir
-
Constructor Summary
ConstructorDescriptionConstructs a new Ghidra jar application layout object. -
Method Summary
Modifier and TypeMethodDescriptionprotected ResourceFile
Returns the directory where all Ghidra extension archives are stored.protected List
<ResourceFile> Returns a prioritized list of directories where Ghidra extensions are installed.protected ResourceFile
Finds the application installation directory for this Ghidra application layout.protected Collection
<ResourceFile> Finds the application root directories for this application layout.Finds the modules for this Ghidra application layout.boolean
Checks whether or not the application is using a "single jar" layout.Methods inherited from class ghidra.GhidraApplicationLayout
findPatchDirectory
Methods inherited from class utility.application.ApplicationLayout
getApplicationInstallationDir, getApplicationProperties, getApplicationRootDirs, getExtensionArchiveDir, getExtensionInstallationDirs, getModules, getPatchDir, getUserCacheDir, getUserSettingsDir, getUserTempDir
-
Constructor Details
-
GhidraJarApplicationLayout
Constructs a new Ghidra jar application layout object.- Throws:
FileNotFoundException
- if there was a problem getting a user directory.IOException
- if there was a problem getting the application properties or modules.
-
-
Method Details
-
inSingleJarMode
public boolean inSingleJarMode()Description copied from class:ApplicationLayout
Checks whether or not the application is using a "single jar" layout. Custom application layouts that extend this class can override this method once they determine they are in single jar mode.- Overrides:
inSingleJarMode
in classApplicationLayout
- Returns:
- true if the application is using a "single jar" layout; otherwise, false.
-
findGhidraApplicationRootDirs
Description copied from class:GhidraApplicationLayout
Finds the application root directories for this application layout.- Overrides:
findGhidraApplicationRootDirs
in classGhidraApplicationLayout
- Returns:
- A collection of the application root directories for this layout.
-
findGhidraApplicationInstallationDir
Description copied from class:GhidraApplicationLayout
Finds the application installation directory for this Ghidra application layout.- Overrides:
findGhidraApplicationInstallationDir
in classGhidraApplicationLayout
- Returns:
- The application installation directory for this Ghidra application layout. Could be null if there is no application installation directory.
-
findGhidraModules
Description copied from class:GhidraApplicationLayout
Finds the modules for this Ghidra application layout.- Overrides:
findGhidraModules
in classGhidraApplicationLayout
- Returns:
- The modules for this Ghidra application layout.
- Throws:
IOException
- if there was a problem finding the modules on disk.
-
findExtensionArchiveDirectory
Description copied from class:GhidraApplicationLayout
Returns the directory where all Ghidra extension archives are stored. This should be at the following location:
{install dir}/Extensions/Ghidra
- Overrides:
findExtensionArchiveDirectory
in classGhidraApplicationLayout
- Returns:
- the archive folder, or null if can't be determined
-
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
(Release Mode)ghidra/Ghidra/Extensions
(Development Mode)
- Overrides:
findExtensionInstallationDirectories
in classGhidraApplicationLayout
- Returns:
- the install folder, or null if can't be determined
-