Ghidra API

https://ghidra.re/ghidra_docs/api
Admin
The Ghidra API provides programmatic access to Ghidra's powerful software reverse engineering...
Tokens:8,411,375
Snippets:76,466
Trust Score:7.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### setupOptions

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

Sets up Jython code completion Options.

```APIDOC
## setupOptions

### Description
Sets up Jython code completion Options.

### Method
static void

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

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

### Get Start Element

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

Returns the start element of this node.

```APIDOC
## getStartElement()

### Description
Returns the start element of this node.

### Returns
* `XmlElement` - the start element of this node
```

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

### Get Instruction Start

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

Retrieves the starting address of the instruction.

```APIDOC
## getInstructionStart()

### Description
Returns the starting address of the instruction.

### Returns
`Address` - The starting address of the instruction.

### Method
`Address getInstructionStart()`
```

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

### Install Help Set

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

Installs a master help set from a given URL. This is a static method that can be called directly.

```APIDOC
## install

### Description
Installs a master help set from a given URL.

### Method
static void

### Parameters
#### Path Parameters
- **masterHelpSetUrl** (URL) - Required - The URL of the master help set to install.

### Endpoint
N/A (Static method call)
```

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

### Get Start Address

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

Returns the starting address of this instruction block.

```APIDOC
## getStartAddress()

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

### Returns
- **Address** - The starting address of the block.
```

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

### setupOptions

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

Sets up Jython code completion options for the Jython plugin.

```APIDOC
## setupOptions

### Description
Sets up Jython code completion Options.

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

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

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

### init Method

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

Initializes the GolangElfInfoProducer instance with an ElfLoadHelper.

```APIDOC
## init(ElfLoadHelper newElfLoadHelper)

### Description
Initializes this instance with the provided Elf binary.

### Method
`public void init(ElfLoadHelper newElfLoadHelper)`

### Parameters
* **newElfLoadHelper** (ElfLoadHelper) - The Elf binary.
```

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

### Get Start Vertex

Source: https://ghidra.re/ghidra_docs/api/ghidra/graph/viewer/edge/AbstractVisualEdge.html

Retrieves the starting vertex (tail) of the edge.

```APIDOC
## getStart

### Description
Get the start, or tail, of the edge. In the edge x -> y, x is the start.

### Signature
`public V getStart()`

### Returns
The starting vertex of the edge.
```

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

### run Method

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 main initialization task for the file system.

### Method
`void run()`

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

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

### Start Snap Retrieval

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

Gets the start snap (timestamp) of this code unit.

```APIDOC
## getStartSnap()

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

### Method
long
```

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

### Extension Installation Path

Source: https://ghidra.re/ghidra_docs/api/ghidra/util/extensions/ExtensionDetails.html

Methods to get and set the installation path and directory of an extension.

```APIDOC
## Extension Installation Path

### getInstallPath
Returns the location where this extension is installed. If the extension is not installed this will be null.

#### Returns
* **String** - the extension path, or null

### getInstallDir
Returns the installation directory of the extension.

#### Returns
* **File** - the installation directory

### setInstallDir
Sets the installation directory for the extension.

#### Parameters
* **installDir** (File) - the directory to set as the installation directory
```

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

### helpExists()

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

Returns true if the help system has been initialized properly; false if help does not exist or is not working.

```APIDOC
## helpExists()

### Description
Returns true if the help system has been initialized properly.

### Method
public boolean helpExists()

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

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```java
// Example usage:
boolean exists = helpService.helpExists();
```

### Response
#### Success Response (boolean)
- **true** (boolean) - if the help system is initialized and working
- **false** (boolean) - if the help system does not exist or is not working

#### Response Example
```json
{
  "example": true
}
```
```

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

### init Method

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/elf/info/StandardElfInfoProducer.html

Initializes the StandardElfInfoProducer with an ElfLoadHelper.

```APIDOC
## init(ElfLoadHelper elfLoadHelper)

### Description
Initializes this instance with the provided ElfLoadHelper.

### Method
`void init(ElfLoadHelper elfLoadHelper)`

### Parameters
#### Path Parameters
- **elfLoadHelper** (ElfLoadHelper) - The Elf binary to initialize with.
```

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

### Get Known GUID from String

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

Retrieves information about a known GUID from its string representation.

```APIDOC
## getKnownGuid

### Description
Retrieves information about a known GUID from its string representation.

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

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

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

### init

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

Initializes the instance to be ready for use.

```APIDOC
## init 
public void init(TaskMonitor monitor) throws IOException

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

### Parameters
- `monitor` (TaskMonitor) - TaskMonitor to control the initialization process.

### Throws
- `IOException` - if error reading data
```

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

### Get Known Versioned GUID

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

Retrieves information about a known versioned GUID from its string representation.

```APIDOC
## getKnownVersionedGuid

### Description
Retrieves information about a known versioned GUID from its string representation.

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

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

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

### DBInitializer.run()

Source: https://ghidra.re/ghidra_docs/api/db/DBInitializer.html

Executes the initialization logic.

```APIDOC
## run()

### Description
Executes the initialization logic.

### Method
`void run()`

### Implements
`run` in interface `Runnable`
```

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

### 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
```java
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
```

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

### 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
```

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

### install

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

Installs the editor kit to the given JEditorPane.

```APIDOC
## install(JEditorPane c)

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

### Method
public void install(JEditorPane c)

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

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

### Get Addresses Iterator from Start

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/address/AddressSetView.html

Returns an iterator to traverse addresses starting from a specified address, in a given direction.

```APIDOC
## getAddresses
AddressIterator getAddresses(Address start, boolean forward)

### Description
Returns an iterator over the addresses in this address set starting at the start address.

### Parameters
- `start` (Address) - Address to start iterating at in the address set.
- `forward` (boolean) - If true, addresses are returned from lowest to highest; else from highest to lowest.

### Returns
- AddressIterator - An iterator over the addresses in this address set starting at the start address.
```

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

### AbstractEmuUnixFileSystem 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.

### Method
public

### Parameters
None
```

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

### getFunctions (iterator from start address)

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

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

### Method
public FunctionIterator getFunctions(Address start, boolean forward)

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

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

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

### Constructor

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

Initializes a new EmulatorHelper instance.

```APIDOC
## Constructor EmulatorHelper

### Description
Initializes a new EmulatorHelper instance with the given Program.

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

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

### Get BuiltinTypeDescriptor Stride

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/swift/types/BuiltinTypeDescriptor.html

Retrieves the stride, which is the distance in bytes between the start of one element and the start of the next in an array of this type.

```java
public int getStride()
```

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

### init

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

Discovers available Go types.

```APIDOC
## init

### Description
Discovers available Go types.

### Parameters
- **monitor** (TaskMonitor) - The task monitor to track progress.

### Throws
- **IOException** - if error reading data or cancelled.
```

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

### 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

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

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

### 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()`
```

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

### 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 useful objects and services.

```APIDOC
## init(FSBFileHandlerContext context)

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

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

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

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

### Get GUID String

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

Retrieves the string representation of a GUID stored at a specific address within a Ghidra program, with optional validation.

```APIDOC
## getGuidString

### Description
Retrieves the string representation of a GUID stored at a specific address within a Ghidra program, with optional validation.

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

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

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

### installHelpService

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

Installs a custom HelpService for the application. This is typically used for setting up or replacing the default help service.

```APIDOC
## installHelpService

### Description
Install the help service.

### Method
```java
public static void installHelpService(HelpService service)
```

### Parameters
#### Request Body
- **service** (HelpService) - The HelpService instance to install.
```

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

### Get Known GUID from Program Address

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

Retrieves information about a known GUID located at a specific address within a Ghidra program.

```APIDOC
## getKnownGuid

### Description
Retrieves information about a known GUID located at a specific address within a Ghidra program.

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

### Parameters
- **program** (Program) - The Ghidra program.
- **address** (Address) - The memory address where the GUID is stored.
```

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

### 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, forward)

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

Retrieves an iterable of code units starting from a specific address and iterating in a given direction for a particular snap.

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

### Description
Retrieves an iterable of code units starting from a specific address and iterating in a given direction for a particular snap.

### Method
public Iterable<? extends T> get(long snap, Address start, boolean forward)

### Parameters
- **snap** (long) - The snap identifier.
- **start** (Address) - The starting address.
- **forward** (boolean) - true to iterate forward, false for backward.

### Returns
- Iterable<? extends T> - An iterable of code units starting from the specified address.
```

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

### 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`.

### Method Signature
`protected HelpLocation getInstalledProcessorsHelpLocation()`

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

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

### main(String[] args)

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

Entry point for command-line usage to de-obfuscate files.

```APIDOC
## main(String[] args)

### Description
Entry point to enable command line users to retrieve the contents of an obfuscated file.

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

### Parameters
* **args** (String[]) - Arguments can be "--help" for usage information, or [ "input_filename", "output_filename" ] to process a file.

### Throws
`IOException` - if an error occurs during file processing.
```

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

### getLineNumber

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

Gets the line number where the XML element starts.

```APIDOC
## getLineNumber

### Description
Returns the line number where the XML element begins in the source.

### Method
GET

### Endpoint
N/A (Instance Method)

### Parameters
None

### Response
#### Success Response (200)
- **lineNumber** (int) - The line number of the element's start.
```

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

### initStarting

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

Called at the beginning of the userop initialization process.

```APIDOC
## initStarting

### Description
This method is invoked at the start of the initialization phase for a userop. It allows for pre-initialization logic.

### Method
`protected void initStarting()`

### Overrides
`initStarting` in class `AnnotatedPcodeUseropLibrary.AnnotatedPcodeUseropDefinition<T>`
```

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

### getColumnNumber

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

Gets the column number where the XML element starts.

```APIDOC
## getColumnNumber

### Description
Returns the column number where the XML element begins in the source.

### Method
GET

### Endpoint
N/A (Instance Method)

### Parameters
None

### Response
#### Success Response (200)
- **columnNumber** (int) - The column number of the element's start.
```

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

### 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` instance.

### 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` that should be polled to see if the user has requested to cancel the operation, and updated with progress information.

### 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.

```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 configuration for the JIT compiler.
- **lookup** (MethodHandles.Lookup) - The lookup object for method handle creation.
```

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

### 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 stored at a specific address within a Ghidra program, with optional validation.

```APIDOC
## getVersionedGuidString

### Description
Retrieves the string representation of a versioned GUID stored at a specific address within a Ghidra program, with optional validation.

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

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

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

### get (Address)

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/model/listing/TraceBaseCodeUnitsView.html

Retrieves live code units whose start addresses are within a specified range starting from a given address for a specific snap.

```APIDOC
## get
Iterable<? extends T> get(long snap, Address start, boolean forward)

### Description
Get the live units whose start addresses are within the specified range.

### Parameters
* `snap` - the snap during which the units must be alive
* `start` - the minimum (forward) or maximum (backward) start address, inclusive
* `forward` - true to order the units by increasing address, false for descending

### Returns
the iterable of units
```

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

### doInitialize

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

Internal initialization method.

```APIDOC
## doInitialize

### Description
Internal initialization method.

### Method
protected void

### Signature
doInitialize()
```

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

### Get Start Addresses

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/block/ExtCodeBlockImpl.html

Gets all entry points to this block. Depending on the model, there may be more than one entry point. This method is part of the CodeBlock interface.

```APIDOC
## getStartAddresses

### Description
Get all the entry points to this block. Depending on the model, there may be more than one entry point. Entry points will be returned in natural sorted order.

Specified by:
`getStartAddresses` in interface `CodeBlock`

### Signature
```java
public Address[] getStartAddresses()
```

### Returns
* an array of entry points to this block. a zero length array if there are no entry points.
```

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

### init Method

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

Initializes the file handler with the provided context.

```APIDOC
## init(FSBFileHandlerContext context)

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

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

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

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

### 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.

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

### Returns
- a new `GFileSystem` derived instance.
```

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

### getFilteredMemState

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

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

```APIDOC
## getFilteredMemState

ghidra.app.emulator.FilteredMemoryState getFilteredMemState()

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

### Returns
the state
```

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

### 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.
```

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

### create

Source: https://ghidra.re/ghidra_docs/api/ghidra/pcode/emu/taint/TaintEmulatorFactory.html

Creates a PcodeMachine emulator with trace and debugger access, and UI integration callbacks.

```APIDOC
## create

### Description
Create the emulator with trace and debugger access, and UI integration callbacks.

### Method
`public PcodeMachine<?> create(PcodeDebuggerAccess access, TraceEmulationIntegration.Writer writer)`

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

#### Query Parameters
- None

#### Request Body
- None

### Parameters
- **access** (PcodeDebuggerAccess) - the trace-and-debugger access shim
- **writer** (TraceEmulationIntegration.Writer) - the Debugger's emulation callbacks for UI integration

### Returns
- PcodeMachine<?> - the emulator with callbacks installed
```

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

### open

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

Opens the file system, initializing resources.

```APIDOC
## open(TaskMonitor monitor)

### Description
Opens the file system.

### Parameters
#### Path Parameters
- **monitor** (TaskMonitor) - a task monitor

### Throws
- `IOException` - if an I/O error occurs
- `CryptoException` - if an encryption error occurs
- `CancelledException`
```

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

### 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
Gets 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) - The register to retrieve the start value for.
- `fromAddr` (Address) - The flow from address (currently unused, for future use to retrieve multiple flows).
- `toAddr` (Address) - The address of the instruction to retrieve the register flow state.
- `signed` (boolean) - True if the value is signed; will sign-extend the top bit based on the value size.

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

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

### startOfFile Method

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

Called at the beginning of processing a file.

```APIDOC
## startOfFile

### Description
Called at the beginning of processing a file.

### Method
public void startOfFile(Path localFile)

### Parameters
- **localFile** (Path) - The path to the local file being processed.

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

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

### getReferenceIterator

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

Gets an iterator over references starting from a specified '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
ReferenceIterator

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

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

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

### Method: main

Source: https://ghidra.re/ghidra_docs/api/docking/widgets/fieldpanel/internal/TestBigLayoutModel.html

Entry point for the TestBigLayoutModel.

```APIDOC
## Method: main

### Description
Entry point for the TestBigLayoutModel. This method is typically used for testing or standalone execution.

### Parameters
- **args** (String[]) - Command line arguments.
```

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

### getBeginPosition

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

Gets the starting vertical pixel position of a specific layout.

```APIDOC
## getBeginPosition

### Signature
`int getBeginPosition(int i)`

### Description
Returns the y-coordinate of the top of the specified layout.

### Parameters
* **i** (int) - The index of the layout.
```

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

### addInstructionSet (with platform)

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/model/listing/TraceInstructionsView.html

Creates multiple instructions for a specified platform. This method is useful for batch creation of instructions and handles conflicts by recording them in the provided `instructionSet`.

```APIDOC
## addInstructionSet

### Description
Create several instructions

### Method Signature
`AddressSetView addInstructionSet(Lifespan lifespan, TracePlatform platform, InstructionSet instructionSet, boolean overwrite)`

### Parameters
- `lifespan` (Lifespan) - the lifespan for all instruction units
- `platform` (TracePlatform) - the optional guest platform, null for the host
- `instructionSet` (InstructionSet) - the set of instructions to add
- `overwrite` (boolean) - true to replace conflicting instructions

### Returns
- `AddressSetView` - the (host) address set of instructions actually added

### Notes
This does not throw `CodeUnitInsertionException`. Conflicts are instead recorded in the `instructionSet`.
```

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

### 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
`static long`

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

### Returns
- `long` - The start address of the PRELINK Mach-O in memory.
```

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

### initialize

Source: https://ghidra.re/ghidra_docs/api/ghidra/features/bsim/query/protocol/NullStaging.html

Establishes the first query stage.

```APIDOC
## initialize

### Description
Establish the first query stage.

### Method
`boolean initialize(BSimQuery<?> q)`

### Parameters
#### Path Parameters
- **q** (BSimQuery<?>) - Required - The query to initialize.

### Returns
`true` if the initial query is constructed, `false` otherwise.

### Throws
- `LSHException` - if the initialization fails.
```

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

### 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 to the fall-through instruction. This accounts for any instructions contained within delay slots.

### Returns
- Default fall-through offset or zero (0) if the instruction has no fall through.
```

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

### getAddressString

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/PseudoData.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. 

Specified by:
    `getAddressString` in interface `CodeUnit` 

### Parameters
* `showBlockName` (boolean) - true if the string should include the memory block name
* `pad` (boolean) - 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
```

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

### Constructor

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

Initializes a new instance of the FileSystemBrowserPlugin.

```APIDOC
## FileSystemBrowserPlugin Constructor

### Description
Initializes a new instance of the FileSystemBrowserPlugin.

### Parameters
#### Parameters
- **tool** (PluginTool) - The plugin tool instance.
```

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

### DBDomainObjectSupport.init()

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/data/DBDomainObjectSupport.html

Initializes the domain object. This method performs essential setup operations after the object has been constructed.

```APIDOC
## init()

### Description
Initializes the domain object. This method performs essential setup operations after the object has been constructed.

### Method
`public void init() throws CancelledException, IOException, VersionException, ServiceConstructionException`

### Throws
* `CancelledException`
* `IOException`
* `VersionException`
* `ServiceConstructionException`
```

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

### getStart

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

Gets the start cursor position of the current search result.

```APIDOC
## getStart()

### Description
Returns the start cursor position of the current search result.

### Method
CursorPosition
```

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

### Constructor

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

Initializes a new FileSystemIndexHelper for a given GFileSystem.

```APIDOC
## FileSystemIndexHelper(GFileSystem fs, FSRLRoot fsFSRL)

### Description
Creates a new `FileSystemIndexHelper` for the specified `GFileSystem`.

### Parameters
- **fs** (GFileSystem) - The GFileSystem instance.
- **fsFSRL** (FSRLRoot) - The root FSRL for the filesystem.
```

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

### Lifespan Retrieval

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

Gets the lifespan (start and end snaps) of this code unit.

```APIDOC
## getLifespan()

### Description
Get the lifespan of this code unit.

### Method
Lifespan
```

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

### getParentOffset

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

Gets the offset of this data item relative to the start of its immediate parent.

```APIDOC
## getParentOffset

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

### Returns
the offset
```

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

### Constructor

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

Initializes a new instance of the ServerInfoComponent.

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

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

### FrameDescriptionEntry.getAugmentationExDataAddress

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

Gets the starting memory address for the call frame augmentation data.

```APIDOC
## getAugmentationExDataAddress()

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

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

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

### Method: initialize

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

Initializes the panel for the ProjectTypeStep.

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

### Description
Initializes the panel as though this is the first time it is being displayed. This method should initialize all GUI fields from the given data object. The GUI component can be created lazily if not done in the constructor, as this method is always called before `getComponent()`.

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

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

### ConsoleApiNative.STARTUPINFOEX.ByReference Constructor

Source: https://ghidra.re/ghidra_docs/api/ghidra/pty/windows/jna/ConsoleApiNative.STARTUPINFOEX.ByReference.html

Constructs a new instance of ConsoleApiNative.STARTUPINFOEX.ByReference.

```APIDOC
## Constructor

### ByReference

```java
public ByReference()
```

**Description**

Constructs a new instance of the `ByReference` class.
```

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

### Get Entry Address

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/assembler/AssemblyBuffer.html

Retrieve the starting address of the assembled code buffer.

```java
public Address getEntry()
```

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

### TaintEmuUnixFileSystem Constructor

Source: https://ghidra.re/ghidra_docs/api/ghidra/pcode/emu/taint/lib/TaintEmuUnixFileSystem.html

Initializes a new instance of the TaintEmuUnixFileSystem.

```APIDOC
## TaintEmuUnixFileSystem()

### Description
Initializes a new instance of the TaintEmuUnixFileSystem.

### Constructor
public TaintEmuUnixFileSystem()
```

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

### 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 at a given address, ordered by entry address. Real functions have 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.
```

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

### CliStreamGuid Methods

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/pe/cli/streams/CliStreamGuid.html

Provides methods for interacting with the GUID stream, including getting the stream name, parsing the stream, retrieving specific GUIDs, and converting the stream to a data type.

```APIDOC
## String getName()

### Description
Gets the name of this stream.

### Returns
- `String` - The name of this stream.

## boolean parse()

### Description
Parses this stream. This method is inherited from `CliAbstractStream`.

### Returns
- `boolean` - True if parsing completed successfully; otherwise, false.

### Throws
- `IOException` - If there was an IO problem while parsing.

## GUID getGuid(int index)

### Description
Gets the GUID at the given index.

### Parameters
- **index** (int) - The index of the GUID to get.

### Returns
- `GUID` - The GUID at the given index. Could be null if the index was invalid or there was a problem reading the GUID.

## DataType toDataType()

### Description
Returns a structure datatype representing the contents of the implementor of this interface. This method is inherited from `StructConverter`.

### Returns
- `DataType` - A structure datatype representing the implementor of this interface.

### Throws
- `DuplicateNameException` - when a datatype of the same name already exists.
- `IOException` - if an IO-related error occurs.
```

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

### dockingSetUp

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

Performs setup operations for the docking environment.

```APIDOC
## dockingSetUp

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

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

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

### Start and End Transaction with DBHandle

Source: https://ghidra.re/ghidra_docs/api/db/Transaction.html

This example shows the traditional way to start and end a transaction using DBHandle directly. Ensure to always end the transaction in a finally block.

```java
 int txid = dbHandle.startTransaction();
 try {
        // ... Do something
 } 
 finally {
        program.endTransaction(txid, true);
 }
 
```

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

### init Method

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

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

```APIDOC
## init(FSBFileHandlerContext context)

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

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

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

#### Query Parameters
- None

#### Request Body
- None

### Parameters
- `context` (FSBFileHandlerContext) - references to useful objects and services
```
Tokens:
Raw