Ghidra

https://ghidra.re/
Admin
Ghidra is a software reverse engineering IDE providing integrated tools for disassembly,...
Tokens:8,600,602
Snippets:81,084
Trust Score:7.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### install

Source: https://ghidra.re/ghidra_docs/api/docking/help/TestHelpService.html

Installs the master help set. This is a static method that takes a URL to the master help set.

```APIDOC
## install

### Description
Installs the master help set.

### Method
static void

### Parameters
#### Path Parameters
- **masterHelpSetUrl** (URL) - Description: The URL to the master help set.
```

--------------------------------

### Get Known GUID from String

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GuidUtil.html

Retrieves GUID information from a string representation of a GUID.

```APIDOC
## getKnownGuid

### Description
Retrieves GUID information from a string representation of a GUID.

### Method
`public static GuidInfo getKnownGuid(String guidString)`

### Parameters
- **guidString** (String) - The string representation of the GUID.
```

--------------------------------

### Get Known Versioned GUID

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GuidUtil.html

Retrieves GUID information from a string representation of a versioned GUID.

```APIDOC
## getKnownVersionedGuid

### Description
Retrieves GUID information from a string representation of a versioned GUID.

### Method
`public static GuidInfo getKnownVersionedGuid(String versionedGuidString)`

### Parameters
- **versionedGuidString** (String) - The string representation of the versioned GUID.
```

--------------------------------

### Initialize

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/golang/rtti/GoRttiMapper.html

Finishes making this instance ready to be used.

```APIDOC
## init(TaskMonitor monitor)

### Description
Finishes making this instance ready to be used.

### Parameters
* **monitor** (TaskMonitor) - The task monitor for progress updates.
```

--------------------------------

### Get Instruction Start

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/listing/InstructionPcodeOverride.html

Retrieves the starting address of the current instruction.

```APIDOC
## getInstructionStart()

### Description
Gets the starting address of the current instruction.

### Returns
Address - The current instruction address.
```

--------------------------------

### install

Source: https://ghidra.re/ghidra_docs/api/ghidra/base/help/GhidraHelpService.html

Installs the Ghidra help service. This is a static method that should be called once to set up the help system.

```APIDOC
## install

### Description
Installs the Ghidra help service.

### Method
static void

### Signature
public static void install()
```

--------------------------------

### setupOptions

Source: https://ghidra.re/ghidra_docs/api/ghidra/jython/JythonCodeCompletionFactory.html

Sets up Jython code completion options within the Ghidra Options system.

```APIDOC
## Method Details

### setupOptions
public static void setupOptions(JythonPlugin plugin, Options options)

Sets up Jython code completion Options.

### Parameters
* `plugin` - jython plugin as options owner
* `options` - an Options handle
```

--------------------------------

### Get GUID String

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GuidUtil.html

Retrieves the string representation of a GUID from a program address.

```APIDOC
## getGuidString

### Description
Retrieves the string representation of a GUID stored at a specific address within a program.

### Method
`public static String getGuidString(Program program, Address address, boolean validate)`

### Parameters
- **program** (Program) - The program to search within.
- **address** (Address) - The memory address where the GUID is located.
- **validate** (boolean) - Whether to validate the GUID.
```

--------------------------------

### Get GUID Data4

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GUID.html

Retrieves the 8-byte array representing the remaining parts of the GUID.

```java
public byte[] getData4()
```

--------------------------------

### setupOptions

Source: https://ghidra.re/ghidra_docs/api/ghidra/jython/JythonCodeCompletionFactory.html

Sets up Jython code completion Options for a given plugin.

```APIDOC
## setupOptions(JythonPlugin plugin, Options options)

### Description
Sets up Jython code completion Options.

### Method
`static void setupOptions(JythonPlugin plugin, Options options)`
```

--------------------------------

### Constructor: AbstractEmuUnixFile

Source: https://ghidra.re/ghidra_docs/api/ghidra/pcode/emu/unix/AbstractEmuUnixFile.html

Initializes a new emulated Unix file with a given pathname and mode.

```APIDOC
## Constructor: AbstractEmuUnixFile

### Description
Construct a new file. Technically, a file can be hardlinked to several pathnames, but for simplicity, or for diagnostics, we let the file know its own original name.

### Parameters
* `pathname` (String) - the pathname of the file
* `mode` (int) - the mode of the file

### See Also
* `AbstractEmuUnixFileSystem.newFile(String, int)`
```

--------------------------------

### Get GUID Data1

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GUID.html

Retrieves the first 8 hexadecimal digits of the GUID as an integer.

```java
public int getData1()
```

--------------------------------

### run()

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/store/FileSystemInitializer.html

Executes the initialization logic for the file system.

```APIDOC
## run()

### Description
Performs the file system initialization. This method is part of the Runnable interface.

### Method
public void run()

### Implements
`Runnable.run()`
```

--------------------------------

### get

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/database/listing/InternalBaseCodeUnitsView.html

Gets the live code units whose start addresses are within the given register.

```APIDOC
## get

### Description
Get the live units whose start addresses are within the given register.

### Method
default Iterable<? extends T>

### Signature
default Iterable<? extends T> get(TracePlatform platform, long snap, Register register, boolean forward)

### Parameters
* **platform** (TracePlatform) - the platform whose language defines the register
* **snap** (long) - the snap during which the units must be alive
* **register** (Register) - the register
* **forward** (boolean) - true to order the units by increasing address, false for descending

### Returns
(Iterable<? extends T>) - the iterable of units
```

--------------------------------

### Get GUID Data3

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GUID.html

Retrieves the second group of 4 hexadecimal digits of the GUID as a short.

```java
public short getData3()
```

--------------------------------

### Program Ready

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/database/symbol/SymbolManager.html

Callback invoked after the program has completed initialization, allowing managers to perform setup.

```APIDOC
## programReady(OpenMode openMode, int currentRevision, TaskMonitor monitor)

### Description
Callback from program made to each manager after the program has completed initialization.

### Method
void programReady(OpenMode openMode, int currentRevision, TaskMonitor monitor)
```

--------------------------------

### Constructor

Source: https://ghidra.re/ghidra_docs/api/ghidra/pcode/emu/unix/AbstractEmuUnixFileSystem.html

Initializes a new instance of the AbstractEmuUnixFileSystem class.

```APIDOC
## AbstractEmuUnixFileSystem()

### Description
Initializes a new instance of the `AbstractEmuUnixFileSystem` class.

### Constructor
`public AbstractEmuUnixFileSystem()`
```

--------------------------------

### Get GUID Data2

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GUID.html

Retrieves the first group of 4 hexadecimal digits of the GUID as a short.

```java
public short getData2()
```

--------------------------------

### installHelpSearcher

Source: https://ghidra.re/ghidra_docs/api/docking/help/DockingHelpBroker.html

Installs the help searcher for the docking framework.

```APIDOC
## protected void installHelpSearcher(javax.help.JHelp jHelp, javax.help.HelpModel helpModel)

### Description
Installs the help searcher.

### Parameters
* **jHelp** (javax.help.JHelp) - The JHelp component.
* **helpModel** (javax.help.HelpModel) - The HelpModel to use for searching.
```

--------------------------------

### Get Versioned GUID String

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GuidUtil.html

Retrieves the string representation of a versioned GUID from a program address.

```APIDOC
## getVersionedGuidString

### Description
Retrieves the string representation of a versioned GUID stored at a specific address within a program.

### Method
`public static String getVersionedGuidString(Program program, Address address, boolean validate)`

### Parameters
- **program** (Program) - The program to search within.
- **address** (Address) - The memory address where the GUID is located.
- **validate** (boolean) - Whether to validate the GUID.
```

--------------------------------

### Get Instruction Prototype Length

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/listing/Instruction.html

Example showing how to get the default instruction length from its prototype.

```java
InstructionPrototype proto = instruction.getPrototype();
int length = proto.getLength();

```

--------------------------------

### installInGui

Source: https://ghidra.re/ghidra_docs/api/generic/theme/ThemeManager.html

Installs the current theme into the GUI.

```APIDOC
## installInGui

### Description
Installs the current theme into the GUI.

### Method
```java
protected void installInGui()
```
```

--------------------------------

### emulateLaunch (Program, Address)

Source: https://ghidra.re/ghidra_docs/api/ghidra/debug/flatapi/FlatDebuggerAPI.html

Loads a program into a trace for emulation, starting at a specified address.

```APIDOC
## emulateLaunch
default Trace emulateLaunch(Program program, Address address) throws IOException

### Description
Load the given program into a trace suitable for emulation in the UI, starting at the given address 
Note that the program bytes are not actually loaded into the trace. Rather a static mapping is generated, allowing the emulator to load bytes from the target program lazily. The trace is automatically loaded into the UI (trace manager).

### Parameters
* `program` (Program) - the target program
* `address` (Address) - the initial program counter

### Returns
Trace - the resulting trace

### Throws
* `IOException` - if the trace cannot be created
```

--------------------------------

### Get Installation Directory

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/Application.html

Returns the main directory where Ghidra is installed on the system. This is the top-level directory of the application.

```java
ResourceFile installDir = Application.getInstallationDirectory();
```

--------------------------------

### BSimLaunchable.initializeApplication(ApplicationLayout layout, int type, String connectingUserName, String certPath)

Source: https://ghidra.re/ghidra_docs/api/ghidra/features/bsim/query/ingest/BSimLaunchable.html

Initializes the Ghidra application from a cold start to various stages.

```APIDOC
## initializeApplication(ApplicationLayout layout, int type, String connectingUserName, String certPath)

### Description
From a cold start, initialize the Ghidra application to different stages, based on future requirements.

### Method
`public static void initializeApplication(ApplicationLayout layout, int type, String connectingUserName, String certPath)`

### Parameters
#### Path Parameters
- **layout** (ApplicationLayout) - application layout.
- **type** (int) - is an integer indicating how much to initialize: 0 - limited initialization, enough simple execution and logging; 1 - full initialization of ghidra for module path info and initialization; 2 - same as #1 with class search for extensions.
- **connectingUserName** (String) - default user name for server connections.
- **certPath** (String) - PKI certificate path.

### Throws
- `IOException` - if there is a problem initializing the headless authenticator.
```

--------------------------------

### Get Known GUID from Program Address

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/datatype/microsoft/GuidUtil.html

Retrieves GUID information from a specified address within a program.

```APIDOC
## getKnownGuid

### Description
Retrieves GUID information from a specified address within a program.

### Method
`public static GuidInfo getKnownGuid(Program program, Address address)`

### Parameters
- **program** (Program) - The program to search within.
- **address** (Address) - The memory address where the GUID is located.
```

--------------------------------

### getAddressSet(AddressFactory factory, Address start, boolean forward)

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/database/DBTraceUtils.html

Get all the addresses in a factory, starting at the given place. If backward, this yields all addresses coming before start.

```APIDOC
## getAddressSet

### Description
Get all the addresses in a factory, starting at the given place.
If backward, this yields all addresses coming before start.

### Method
public static AddressSetView getAddressSet(AddressFactory factory, Address start, boolean forward)

### Parameters
#### Path Parameters
- **factory** (AddressFactory) - the factory
- **start** (Address) - the start (or end) address
- **forward** (boolean) - true for all after, false for all before

### Returns
the address set
```

--------------------------------

### Constructors

Source: https://ghidra.re/ghidra_docs/api/docking/widgets/button/GButton.html

Details on how to instantiate a GButton.

```APIDOC
## Constructor Details
### GButton 
public GButton()

### GButton 
public GButton(Icon icon)

### GButton 
public GButton(String text)
```

--------------------------------

### getFunctions (start, forward)

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/database/function/FunctionManagerDB.html

Gets an iterator over non-external functions starting at a given address and ordered by entry address.

```APIDOC
## getFunctions (start, forward)

### Description
Gets an iterator over non-external functions starting at a given address and ordered by entry address.

### Method Signature
`FunctionIterator getFunctions(Address start, boolean forward)`

### Parameters
* `start` (Address) - The starting address for the iteration.
* `forward` (boolean) - If true, iterate in ascending address order; otherwise, iterate in descending order.

### Returns
* `FunctionIterator` - An iterator over the functions.
```

--------------------------------

### Constructor

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/emulator/EmulatorHelper.html

Initializes a new EmulatorHelper instance.

```APIDOC
## EmulatorHelper(Program program)

### Description
Constructs an EmulatorHelper for the given program.

### Parameters
* **program** (Program) - The program to associate with the emulator.
```

--------------------------------

### getStartSnap

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/database/module/DBTraceStaticMapping.html

Get the starting snap of the lifespan.

```APIDOC
public long getStartSnap()
```

--------------------------------

### emulateLaunch

Source: https://ghidra.re/ghidra_docs/api/ghidra/debug/flatapi/FlatDebuggerAPI.html

Launches emulation for a given program and address, preparing the trace for UI display.

```APIDOC
## emulateLaunch

### Description
Launches emulation for a given program and address, preparing the trace for UI display. This is a convenience method for `emulateLaunch(Program, Address)` on the current program.

### Method Signature
- `emulateLaunch(Address address)`
- `emulateLaunch(Program program, Address address)`

### Return Type
- `default Trace` (for the first signature)
- `default BigInteger` (for the second signature)
```

--------------------------------

### get (snap, start, forward)

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/database/listing/AbstractBaseDBTraceCodeUnitsView.html

Retrieves an iterable of code units starting from a specific address at a specific snapshot, with directionality.

```APIDOC
## get

### Description
Retrieves an iterable of code units starting from a specific address at a specific snapshot, with directionality.

### Parameters
* `snap` (long) - The snapshot ID.
* `start` (Address) - The starting address.
* `forward` (boolean) - If true, iterate forward; otherwise, iterate backward.

### Returns
(Iterable<? extends T>) - An iterable of code units.

### See Also
* `TraceBaseCodeUnitsView.get(long, Address, boolean)`
```

--------------------------------

### run Method

Source: https://ghidra.re/ghidra_docs/api/ghidra/ProjectInitializer.html

Executes the initialization logic for the project.

```APIDOC
## run()

### Description
Executes the initialization logic for the project. This method is part of the Runnable interface.

### Method
`void run()`

### Implements
`Runnable.run()`
```

--------------------------------

### emulateLaunch (Address)

Source: https://ghidra.re/ghidra_docs/api/ghidra/debug/flatapi/FlatDebuggerAPI.html

Loads the current program into a trace for emulation, starting at a specified address.

```APIDOC
## emulateLaunch
default Trace emulateLaunch(Address address) throws IOException

### Description
Does the same as `emulateLaunch(Program, Address)`, for the current program

### Parameters
* `address` (Address) - the initial program counter

### Returns
Trace - the resulting trace

### Throws
* `IOException` - if the trace cannot be created
```

--------------------------------

### getColumnNumber

Source: https://ghidra.re/ghidra_docs/api/ghidra/xml/XmlElementImpl.html

Gets the column number where this element starts.

```APIDOC
## getColumnNumber

### Description
Gets the column number where this XML element starts in the source.

### Signature
`int getColumnNumber()`
```

--------------------------------

### init Method

Source: https://ghidra.re/ghidra_docs/api/ghidra/plugins/fsbrowser/filehandlers/BatchImportFSBFileHandler.html

Initializes the FSBFileHandler with the provided context, offering access to essential objects and services.

```APIDOC
## init(FSBFileHandlerContext context)

### Description
Called once after creation of each instance to provide useful info.

### Method
`void init(FSBFileHandlerContext context)`

### Parameters
* `context` (FSBFileHandlerContext) - references to useful objects and services
```

--------------------------------

### getStartSnap

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/database/listing/AbstractDBTraceCodeUnit.html

Get the start snap of this code unit.

```APIDOC
## getStartSnap

### Description
Get the start snap of this code unit

Specified by:
`getStartSnap` in interface `TraceCodeUnit`

### Returns
* `long` - the first snap of this unit's lifespan
```

--------------------------------

### install

Source: https://ghidra.re/ghidra_docs/api/help/GHelpHTMLEditorKit.html

Installs the editor kit to the specified JEditorPane.

```APIDOC
## install

### Description
Installs the editor kit to the specified JEditorPane.

### Method Signature
`void install(JEditorPane c)`

### Overrides
`install` in class `HTMLEditorKit`
```

--------------------------------

### getMinAddress

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/PseudoData.html

Gets the starting address of this code unit.

```APIDOC
## getMinAddress

### Description
Get the starting address for this code unit.

### Method
public Address getMinAddress()

### Returns
- Address - the starting address for this code unit.

### Throws
- ConcurrentModificationException - if this object is no longer valid.
```

--------------------------------

### getReferenceIterator

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/symbol/ReferenceManager.html

Gets an iterator for references starting from a specified address.

```APIDOC
## getReferenceIterator

### Description
Get an iterator over references starting with the specified fromAddr. A forward iterator is returned with references sorted on the from address.

### Method
ReferenceIterator

### Parameters
#### Path Parameters
- **startAddr** (Address) - Required - the first from address to consider.

### Returns
a forward memory reference iterator.
```

--------------------------------

### init Method

Source: https://ghidra.re/ghidra_docs/api/ghidra/plugins/fsbrowser/filehandlers/OpenWithFSBFileHandler.html

Initializes the FSBFileHandler with the provided context.

```APIDOC
## init(FSBFileHandlerContext context)

### Description
Called once after creation of each instance to provide useful info.

### Method
public void

### Parameters
#### Path Parameters
* **context** (FSBFileHandlerContext) - references to useful objects and services
```

--------------------------------

### build()

Source: https://ghidra.re/ghidra_docs/api/docking/action/builder/ActionBuilder.html

Builds the DockingAction. Use buildAndInstall or buildAndInstallLocal for immediate installation.

```APIDOC
## build()

### Description
Builds the action. To build and install the action in one step, use `AbstractActionBuilder.buildAndInstall(Tool)` or `AbstractActionBuilder.buildAndInstallLocal(ComponentProvider)`. `AbstractActionBuilder.inWindow(When)`.

### Returns
* **DockingAction** - the newly build action
```

--------------------------------

### Get Start Address

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/lang/InstructionBlock.html

Retrieves the minimum/start address of the InstructionBlock.

```APIDOC
## getStartAddress

### Description
Returns the minimum/start address of the block.

### Signature
`public Address getStartAddress()`

### Returns
The minimum/start address of the block.
```

--------------------------------

### getInstalledProcessorsHelpLocation

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/runtimeinfo/RuntimeInfoPlugin.html

Gets this plugin's installed processors HelpLocation.

```APIDOC
## getInstalledProcessorsHelpLocation()

### Description
Gets this plugin's installed processors `HelpLocation`.

### Returns
This plugin's installed processors `HelpLocation`
```

--------------------------------

### Main Method for Example Usage

Source: https://ghidra.re/ghidra_docs/api/docking/widgets/ListSelectionDialog.html

A static main method demonstrating how to use the `ListSelectionDialog`.

```APIDOC
## `main` Method

### `public static void main(String[] args)`

Entry point for demonstrating the `ListSelectionDialog` functionality. This method is intended for example usage and testing.
```

--------------------------------

### initializeApplication Method

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/headless/GhidraScriptRunner.html

Initializes the Ghidra application with the specified layout, log file, and log4j usage.

```APIDOC
## initializeApplication(ApplicationLayout applicationLayout, String logFile, boolean useLog4j)

### Description
Initializes the Ghidra application.

### Method
`protected void initializeApplication(ApplicationLayout applicationLayout, String logFile, boolean useLog4j)`

### Parameters
* `applicationLayout` (ApplicationLayout) - The application layout to use.
* `logFile` (String) - The path to the log file.
* `useLog4j` (boolean) - Whether to use log4j for logging.
```

--------------------------------

### Get Code Units by Snap, Start Address, and Direction

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/database/listing/AbstractBaseDBTraceCodeUnitsView.html

Retrieves an iterable collection of code units starting from a specific address in a given snapshot.

```APIDOC
## get

### Description
Get code units starting from a specific address in a given snapshot.

### Parameters
* **snap** (long) - The snapshot ID.
* **start** (Address) - The starting address.
* **forward** (boolean) - If true, iterate forward; otherwise, iterate backward.

### Returns
* **Iterable<? extends T>** - An iterable of code units.
```

--------------------------------

### Application Initialization

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/Application.html

Demonstrates how to initialize the Ghidra application with a specific layout and configuration.

```APIDOC
## initializeApplication

### Description
Initializes the Ghidra application. An `ApplicationLayout` and an `ApplicationConfiguration` must be provided.

### Method
`static void initializeApplication(ApplicationLayout layout, ApplicationConfiguration configuration)`

### Parameters
*   **layout** (`ApplicationLayout`) - The application layout to use.
*   **configuration** (`ApplicationConfiguration`) - The application configuration to use.

### Request Example
```java
ApplicationLayout layout = new GhidraApplicationLayout();
ApplicationConfiguration configuration = new GhidraApplicationConfiguration();
Application.initializeApplication(layout, configuration);
```
```

--------------------------------

### getStartSnap

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/database/symbol/DBTraceReference.html

Get the starting snapshot key of this reference's lifespan.

```APIDOC
public long getStartSnap()
Description copied from interface: `TraceReference`
Get the starting snapshot key of this reference's lifespan 
Specified by:
    `getStartSnap` in interface `TraceReference` 
Returns:
    the starting snapshot 
See Also:
    
      * `TraceReference.getLifespan()`
```

--------------------------------

### launch(TraceRmiLaunchOffer offer, TaskMonitor monitor)

Source: https://ghidra.re/ghidra_docs/api/ghidra/debug/flatapi/FlatDebuggerRmiAPI.html

Launches a debug session using the provided offer and a task monitor.

```APIDOC
## launch(TraceRmiLaunchOffer offer, TaskMonitor monitor)

### Description
Launch the given offer with the default or saved arguments.

### Parameters
* `offer` - the offer to launch
* `monitor` - a monitor for the launch stages

### Returns
the launch result, which may indicate errors
```

--------------------------------

### getRegisterVarnodeValue

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/util/VarnodeContext.html

Gets the varnode value of a register at the start of an execution flow.

```APIDOC
## getRegisterVarnodeValue

### Description
Get the value (value, space, size) of a register at the start of the last execution flow taken for the instruction at toAddr.

### Method
public Varnode getRegisterVarnodeValue(Register reg, Address fromAddr, Address toAddr, boolean signed)

### Parameters
* `reg` - register to retrieve the start value
* `fromAddr` - flow from address (not used currently, future use to retrieve multiple flows)
* `toAddr` - address of instruction to retrieve the register flow state
* `signed` - true if value is signed, will sext the top bit based on value size

### Returns
instruction start state value for register, or null if no known state
```

--------------------------------

### getPrelinkStartAddr

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/opinion/MachoPrelinkUtils.html

Gets the start address of the PRELINK Mach-O's in memory.

```APIDOC
## getPrelinkStartAddr

### Description
Gets the start address of the PRELINK Mach-O's in memory.

### Method Signature
`static long getPrelinkStartAddr(MachHeader header)`

### Parameters
* `header` (MachHeader) - The Mach-O header.
```

--------------------------------

### create Method

Source: https://ghidra.re/ghidra_docs/api/ghidra/formats/gfilesystem/factory/GFileSystemBaseFactory.html

Constructs a new GFileSystem instance that handles the specified file.

```APIDOC
## create(FSRLRoot targetFSRL, ByteProvider byteProvider, FileSystemService fsService, TaskMonitor monitor)

### Description
Constructs a new `GFileSystem` instance that handles the specified file. This method is responsible for closing the provided `byteProvider`.

### Method
`GFileSystemBase create(FSRLRoot targetFSRL, ByteProvider byteProvider, FileSystemService fsService, TaskMonitor monitor)`

### Parameters
* **targetFSRL** (FSRLRoot) - The `FSRLRoot` of the filesystem being created.
* **byteProvider** (ByteProvider) - A `ByteProvider` containing the contents of the file being probed. This method is responsible for closing this byte provider instance.
* **fsService** (FileSystemService) - A reference to the `FileSystemService` object.
* **monitor** (TaskMonitor) - A `TaskMonitor` to poll for cancellation and update progress.

### Returns
A new `GFileSystem` derived instance.

### Throws
* `IOException` - if there is an error reading files.
* `CancelledException` - if the user cancels the operation.
```

--------------------------------

### Constructor

Source: https://ghidra.re/ghidra_docs/api/ghidra/pcode/emu/jit/JitPcodeEmulator.html

Creates a new JIT-accelerated p-code emulator instance.

```APIDOC
## JitPcodeEmulator(Language language, JitConfiguration config, MethodHandles.Lookup lookup)

### Description
Create a JIT-accelerated p-code emulator.

### Parameters
* **language** (Language) - The language definition for the emulator.
* **config** (JitConfiguration) - The JIT compilation configuration.
* **lookup** (MethodHandles.Lookup) - The lookup object for method handle creation.
```

--------------------------------

### getAddressString

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/PseudoInstruction.html

Get the string representation of the starting address for this code unit.

```APIDOC
## getAddressString

### Description
Get the string representation of the starting address for this code unit.

### Parameters
* `showBlockName` - true if the string should include the memory block name
* `pad` - if true, the address will be padded with leading zeros. Even if pad is false, the string will be padded to make the address string contain at least 4 digits.

### Returns
string representation of address
```

--------------------------------

### getDefaultFallThroughOffset

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/PseudoInstruction.html

Gets the default fall-through offset in bytes from the start of the instruction.

```APIDOC
## getDefaultFallThroughOffset

### Description
Gets the default fall-through offset in bytes from the start of the instruction. This accounts for any instructions contained within delay slots.

### Returns
* `int` - The default fall-through offset, or zero (0) if the instruction has no fall-through.
```

--------------------------------

### startOfFile Method

Source: https://ghidra.re/ghidra_docs/api/help/validator/ReferenceTagProcessor.html

Called when the processing of a file begins.

```APIDOC
## startOfFile(Path localFile)

### Description
Notifies the processor that the processing of a new file has started.

### Parameters
* **localFile** (Path) - The path to the file that is starting to be processed.

### Overrides
`startOfFile` in class `TagProcessor`
```

--------------------------------

### Method: initialize

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/main/wizard/project/ProjectAccessStep.html

Initializes the panel for the project access step.

```APIDOC
## Method: initialize
public void initialize(ProjectWizardData data)

### Description
Initializes the panel as though this is the first time it is being displayed. This is where the step should initialize all GUI fields from the given data object. Creating the GUI component can be done lazily in this method if not done in the constructor, as the initialize() method will always be called before the getComponent() method is called. Just be careful as this method can be called multiple times if the user backtracks in the wizard dialog.

Specified by:
`initialize` in class `WizardStep<ProjectWizardData>`

### Parameters
* **data** (ProjectWizardData) - The custom wizard data containing the information from all previous steps.
```

--------------------------------

### getParentOffset

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/PseudoData.html

Get the offset of this Data item from the start of its immediate parent.

```APIDOC
## getParentOffset

### Description
Get the offset of this Data item from the start of its immediate parent.

### Method
`int`

### Signature
`getParentOffset()`
```

--------------------------------

### getAugmentationExDataAddress

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/exceptionhandlers/gcc/structures/ehFrame/FrameDescriptionEntry.html

Gets the start address for the call frame augmentation data.

```APIDOC
## getAugmentationExDataAddress()

### Description
Gets the start address for the call frame augmentation data.

### Returns
* Address - The address of the call frame augmentation data.
```

--------------------------------

### initialize

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/main/wizard/project/ProjectAccessStep.html

Initializes the wizard step's UI component with the provided data.

```APIDOC
public void initialize(ProjectWizardData data)
```

--------------------------------

### getAugmentationExDataAddress

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/exceptionhandlers/gcc/structures/ehFrame/FrameDescriptionEntry.html

Gets the starting address for the call frame augmentation data.

```APIDOC
## getAugmentationExDataAddress()

### Description
Gets the start address for the call frame augmentation data.

### Returns
- Address - The start address of the call frame augmentation data.
```

--------------------------------

### Constructor: TutorialScreenShotGenerator

Source: https://ghidra.re/ghidra_docs/api/help/screenshot/TutorialScreenShotGenerator.html

Initializes a new instance of the TutorialScreenShotGenerator class.

```APIDOC
## Constructor: TutorialScreenShotGenerator

### Description
Initializes a new instance of the TutorialScreenShotGenerator class.

### Signature
public TutorialScreenShotGenerator()
```

--------------------------------

### getFilteredMemState

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/emulator/AdaptedEmulator.html

Gets the memory state, modified by all installed access filters.

```APIDOC
## getFilteredMemState()

### Description
Get the memory state, modified by all installed access filters.

Specified by:
`getFilteredMemState` in interface `Emulator`

### Returns
* **FilteredMemoryState** - the filtered memory state.
```

--------------------------------

### DecompInterface Usage Example

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/decompiler/DecompInterface.html

Demonstrates the basic usage pattern for the DecompInterface, including instantiation, option setup, program opening, and function decompilation.

```APIDOC
## DecompInterface Usage Example

This example shows how to use the `DecompInterface` to decompile functions within a program.

### Instantiate the interface
```java
DecompInterface ifc = new DecompInterface();
```

### Setup options and initialization
```java
// Inform interface of global options
ifc.setOptions(options);

// Optional: Disable syntax tree generation
// ifc.toggleSyntaxTree(false);

// Optional: Disable C code generation
// ifc.toggleCCode(false);

// Optional: Set simplification style
// ifc.setSimplificationStyle("normalize");
```

### Open a program for decompilation
```java
// Initialize the decompiler process for a specific program
ifc.openProgram(program);
```

### Decompile a function
```java
// Decompile a specific function
DecompileResults res = ifc.decompileFunction(func, 0, taskMonitor);

// Check for errors
if (!res.decompileCompleted()) {
    System.out.println(res.getErrorMessage());
    return;
}
```

### Access decompilation results
```java
// Get C code markup
ClangTokenGroup tokgroup = res.getCCodeMarkup();

// Get the high-level function representation
HighFunction hfunc = res.getHighFunction();
```
```

--------------------------------

### create

Source: https://ghidra.re/ghidra_docs/api/ghidra/formats/gfilesystem/factory/GFileSystemFactoryByteProvider.html

Constructs a new GFileSystem instance that handles the specified file using a ByteProvider.

```APIDOC
## create

### Description
Constructs a new `GFileSystem` instance that handles the specified file.

### Method
`GFileSystem` create(FSRLRoot targetFSRL, ByteProvider byteProvider, FileSystemService fsService, TaskMonitor monitor)

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Parameters
- **targetFSRL** (`FSRLRoot`) - The `FSRLRoot` of the filesystem being created.
- **byteProvider** (`ByteProvider`) - A `ByteProvider` containing the contents of the file being probed. This method is responsible for closing this byte provider instance.
- **fsService** (`FileSystemService`) - A reference to the `FileSystemService` object.
- **monitor** (`TaskMonitor`) - A `TaskMonitor` that should be polled to see if the user has requested to cancel the operation, and updated with progress information.

### Request Example
```java
// Example usage (conceptual)
GFileSystemFactoryByteProvider factory = ...;
FSRLRoot root = ...;
ByteProvider provider = ...;
FileSystemService fsService = ...;
TaskMonitor monitor = ...;
GFileSystem filesystem = factory.create(root, provider, fsService, monitor);
```

### Response
#### Success Response
- **GFileSystem** - A new `GFileSystem` derived instance.

#### Response Example
```java
// Conceptual response object
// GFileSystem instance
```

### Throws
- `IOException` - if there is an error reading files.
- `CancelledException` - if the user cancels
```

--------------------------------

### Get Varnodes by Address

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/pcode/PcodeSyntaxTree.html

Returns an iterator to all Varnodes that start at a given address.

```APIDOC
## Iterator<VarnodeAST> getVarnodes(Address addr)

### Description
Returns an iterator to all Varnodes that start at the specified address.

### Parameters
* **addr** (Address) - The starting address.
```

--------------------------------

### dockingSetUp

Source: https://ghidra.re/ghidra_docs/api/docking/test/AbstractDockingTest.html

Performs setup operations for the docking framework.

```APIDOC
## dockingSetUp

### Description
Performs setup operations for the docking framework.

### Signature
`void dockingSetUp()`
```

--------------------------------

### getReferenceIterator

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/database/references/ReferenceDBManager.html

Gets an iterator over references starting with the specified fromAddr, sorted by the from address.

```APIDOC
## getReferenceIterator

### Description
Get an iterator over references starting with the specified fromAddr. A forward iterator is returned with references sorted on the from address.

### Method
public ReferenceIterator getReferenceIterator(Address startAddr)

### Parameters
* `startAddr` - the first from address to consider.

### Returns
a forward memory reference iterator.
```

--------------------------------

### files() - No arguments

Source: https://ghidra.re/ghidra_docs/api/ghidra/formats/gfilesystem/GFileSystem.html

Gets an Iterable over this GFileSystem's files, starting from the root.

```APIDOC
## files()

### Description
Gets an `Iterable` over this `GFileSystem`'s files, starting from the root.

### Method Signature
`default Iterable<GFile> files()`

### Returns
* `Iterable<GFile>` - An `Iterable` over this `GFileSystem`'s files.
```

--------------------------------

### initialize

Source: https://ghidra.re/ghidra_docs/api/generic/theme/ApplicationThemeManager.html

Initializes the Theme and its values for the application.

```APIDOC
## initialize

### Description
Initialized the Theme and its values for the application.

### Method
`public static void initialize()`
```

--------------------------------

### getStart

Source: https://ghidra.re/ghidra_docs/api/docking/widgets/TextComponentSearcher.html

Gets the cursor position marking the start of the current search result.

```APIDOC
## getStart()

### Description
Returns the cursor position that marks the start of the currently selected or found text.

### Method
CursorPosition
```

--------------------------------

### open

Source: https://ghidra.re/ghidra_docs/api/ghidra/formats/gfilesystem/GFileSystemBase.html

Opens the file system, initializing resources.

```APIDOC
## open

### Description
Opens the file system, initializing resources.

### Signature
`public abstract void open(TaskMonitor monitor) throws IOException, CryptoException, CancelledException`

### Parameters
* `monitor` (TaskMonitor) - A task monitor.

### Throws
* `IOException` - if an I/O error occurs.
* `CryptoException` - if an encryption error occurs.
* `CancelledException` - if the operation is cancelled.
```

--------------------------------

### getFunctionsNoStubs(Address start, boolean forward)

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/database/function/FunctionManagerDB.html

Gets an iterator over real functions, starting from a specified address and ordered by entry address. Real functions are those that contain instructions and are not stubs.

```APIDOC
## getFunctionsNoStubs(Address start, boolean forward)

### Description
Get an iterator over REAL functions starting at an address and ordered by entry address (real functions have instructions, and aren't stubs).

### Parameters
* `start` (Address) - starting address
* `forward` (boolean) - true means to iterate in ascending address order

### Returns
an iterator over functions.
```

--------------------------------

### Constructor

Source: https://ghidra.re/ghidra_docs/api/docking/DefaultHelpService.html

Initializes a new instance of the DefaultHelpService class.

```APIDOC
## Constructor

### DefaultHelpService

```java
public DefaultHelpService()
```

Initializes a new instance of the DefaultHelpService class.
```

--------------------------------

### getMemoryBlocksStartingWithName

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/util/ProgramMemoryUtil.html

Gets a list of memory blocks whose names start with a specified prefix.

```APIDOC
## getMemoryBlocksStartingWithName

### Description
Gets a list of memory blocks whose name starts with the indicated name.

### Method Signature
`static List<MemoryBlock> getMemoryBlocksStartingWithName(Program program, AddressSetView set, String name, TaskMonitor monitor)`
```

--------------------------------

### initialize

Source: https://ghidra.re/ghidra_docs/api/ghidra/test/AbstractProgramBasedTest.html

Initializes the test environment. This method should be overridden by subclasses to perform specific setup tasks.

```APIDOC
## initialize

### Description
Initializes the test environment. This method should be overridden by subclasses to perform specific setup tasks.

### Method
protected void initialize() throws Exception

### Throws
`Exception`

```

--------------------------------

### getNumUndefinedBytes

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/data/StructureDataType.html

Gets the number of contiguous undefined bytes starting from a specified component index.

```APIDOC
## getNumUndefinedBytes

### Description
Gets the number of contiguous undefined bytes starting from a specified component index. Undefined bytes that have a field name or comment specified are also included.

### Parameters
#### Path Parameters
- **index** (int) - Required - The component index to begin checking at.

### Returns
- **count** (int) - The number of contiguous undefined bytes.
```

--------------------------------

### initStarting

Source: https://ghidra.re/ghidra_docs/api/ghidra/pcode/exec/AnnotatedPcodeUseropLibrary.FixedArgsAnnotatedPcodeUseropDefinition.html

Performs initialization actions at the start of userop processing.

```APIDOC
## initStarting

### Description
Performs initialization tasks before the userop execution begins. This method overrides the superclass implementation.
```

--------------------------------

### getDefaultFallThroughOffset

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/database/code/InstructionDB.html

Gets the default fall-through offset in bytes from the start of the instruction to the fall-through instruction.

```APIDOC
## int getDefaultFallThroughOffset()

### Description
Get default fall-through offset in bytes from start of instruction to the fall-through instruction.
```

--------------------------------

### Constructor

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/main/ServerInfoComponent.html

Initializes a new instance of the ServerInfoComponent.

```APIDOC
## ServerInfoComponent
public ServerInfoComponent()

### Description
Initializes a new instance of the ServerInfoComponent.
```

--------------------------------

### HelpService Access

Source: https://ghidra.re/ghidra_docs/api/help/Help.html

Provides methods to get the application's HelpService and install a custom one.

```APIDOC
## getHelpService

### Description
Get the help service.

### Method
static

### Signature
`static HelpService getHelpService()`

### Returns
a non-null help service

## installHelpService

### Description
Install a custom HelpService for the application.

### Method
static

### Signature
`static void installHelpService(HelpService service)`

### Parameters
- **service** (HelpService) - The HelpService implementation to install.
```

--------------------------------

### initializeApplication

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/Application.html

Initializes the Ghidra application with the provided application layout and configuration.

```APIDOC
## initializeApplication

### Description
Initializes the application.

### Method Signature
`static void initializeApplication(ApplicationLayout layout, ApplicationConfiguration configuration)`
```

--------------------------------

### getFunctions(Address, boolean)

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/database/program/AbstractDBTraceProgramViewListing.html

Gets an iterator over all functions starting from a specified address, ordered by address.

```APIDOC
## getFunctions(Address start, boolean forward)

### Description
Get an iterator over all functions starting at a given address.

### Parameters
* **start** (Address) - The address to start iterating from.
* **forward** (boolean) - If true, functions are returned in ascending address order; otherwise, in descending address order.

### Returns
* an iterator over functions.
```

--------------------------------

### build

Source: https://ghidra.re/ghidra_docs/api/docking/action/builder/MultiStateActionBuilder.html

Builds the MultiStateDockingAction. Use buildAndInstall or buildAndInstallLocal for immediate installation.

```APIDOC
## Method Details

### build
public MultiStateDockingAction<T> build()
Description copied from class: `AbstractActionBuilder`
Builds the action. To build and install the action in one step, use `AbstractActionBuilder.buildAndInstall(Tool)` or `AbstractActionBuilder.buildAndInstallLocal(ComponentProvider)`. `AbstractActionBuilder.inWindow(When)` 

Specified by:
    `build` in class `AbstractActionBuilder<MultiStateDockingAction<T>,ActionContext,MultiStateActionBuilder<T>>` 

Returns:
    the newly build action
```
Tokens:
Raw