### 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) - Required - The URL of the master help set to install.

### Method Signature
`static void install(URL masterHelpSetUrl)`
```

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

### Get Instruction Start Address

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

Retrieves the starting address of the current instruction.

```APIDOC
## getInstructionStart()

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

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

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

### ExamplesPluginPackage Constructor

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/ExamplesPluginPackage.html

Constructs a new ExamplesPluginPackage.

```APIDOC
## ExamplesPluginPackage()

### Description
Constructs a new ExamplesPluginPackage.

### Constructor
`ExamplesPluginPackage()`
```

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

### 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
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
the iterable of units
```

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

### prepareStartupInfo

Source: https://ghidra.re/ghidra_docs/api/ghidra/pty/windows/ConPtyChild.html

Prepares the STARTUPINFOEX structure for process creation.

```APIDOC
## prepareStartupInfo

### Description
Prepares the `STARTUPINFOEX` structure required for launching a process with specific attributes.

### Method
protected ConsoleApiNative.STARTUPINFOEX prepareStartupInfo()

### Returns
A `STARTUPINFOEX` object populated with necessary information.
```

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

### Get Installation Directory

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

Returns the root directory where Ghidra is installed on the system. This is equivalent to `getApplicationRootDirectory()`.

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

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

### install

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

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

```APIDOC
## install

### Description
Installs Ghidra's help service.

### Method
static void

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

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

### Example: Get Instruction Prototype Length

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

Illustrates how to get the default instruction length using the InstructionPrototype.

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

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

### init

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

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

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

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

### Setup and Teardown

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

Methods for initializing and cleaning up the docking environment for tests.

```APIDOC
## dockingSetUp

### Description
Sets up the docking environment for testing.

### Method
void

### Endpoint
dockingSetUp()

### Response
void
```

```APIDOC
## dockingTearDown

### Description
Cleans up the docking environment after testing.

### Method
void

### Endpoint
dockingTearDown()

### Response
void
```

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

### get(snap, start, forward)

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

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

### Get Phases Example

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/merge/listing/ExternalProgramMerger.html

Example of how to return phase information for a merge resolver. This structure is used when a phase has multiple sub-phases.

```java
new String[][] { new String[] {"Phase A"},                    new String[] {"Phase A", "Sub-Phase 1"},                   new String[] {"Phase A", "Sub-Phase 2"} }
```

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

### initialize

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

Initializes the ServerStep panel with data from previous wizard steps.

```APIDOC
## initialize

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

### Signature
`public void initialize(ProjectWizardData data)`

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

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

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

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

### setupOptions

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

Sets up Jython code completion Options for a given plugin.

```APIDOC
## setupOptions

### Description
Sets up Jython code completion Options.

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

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

### getLPStartAddress

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/exceptionhandlers/gcc/structures/gccexcepttable/LSDAHeader.html

Gets the starting address of the landing pad.

```APIDOC
## getLPStartAddress

### Description
Gets the landing pad start address.

### Returns
- the LP start address
```

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

### softStart Methods

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

Retrieves the next element, which must be a start element, optionally matching supplied names.

```APIDOC
## softStart(String... names)

### Description
Returns the next element, which must be a start element, and must be one of the supplied names (if provided).

### Method
`XmlElement softStart(String... names)`
```

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

### setupOptions

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

Sets up the configuration options for Jython code completion within the Ghidra console.

```APIDOC
## setupOptions

### Description
Sets up Jython code completion Options.

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

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

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

### get (snap, register, forward)

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

Gets the live units whose start addresses are within the given register, ordered by address.

```APIDOC
## get

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

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

### Parameters
* `snap` (long) - The snap.
* `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.
```

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

### setupInitialDefaults

Source: https://ghidra.re/ghidra_docs/api/ghidra/plugins/importer/batch/BatchImportDialog.html

Sets up the initial default values for the batch import dialog.

```APIDOC
## setupInitialDefaults

### Description
Sets up the initial default values for the batch import dialog.

### Method
`public boolean`
```

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

### Get (Start Address)

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

Retrieves an iterable of code units starting from the specified address and iterating in the given direction at a specific snapshot.

```APIDOC
## get(long snap, Address start, boolean forward)

### Description
Retrieves an iterable of code units starting from the specified address and iterating in the given direction at a specific 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.

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

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

### 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
Executes the initialization logic for the file system. This method is part of the Runnable interface.

### Method
`void run()`

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

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

### Start Address Management

Source: https://ghidra.re/ghidra_docs/api/ghidra/rmi/trace/TraceRmi.RequestDisassemble.Builder.html

Methods for checking, getting, setting, merging, clearing, and building the start address field for a RequestDisassemble object.

```APIDOC
## hasStart

### Description
Checks if the start address field is set.

### Method
`hasStart()`

### Returns
- `boolean` - True if the start field is set, false otherwise.

## getStart

### Description
Returns the start address field.

### Method
`getStart()`

### Returns
- `TraceRmi.Addr` - The start address.

## setStart

### Description
Sets the start address field.

### Method
`setStart(TraceRmi.Addr value)`

### Parameters
- **value** (TraceRmi.Addr) - The start address value to set.

### Returns
- `TraceRmi.RequestDisassemble.Builder` - The builder instance.

## setStart

### Description
Sets the start address field using a builder.

### Method
`setStart(TraceRmi.Addr.Builder builderForValue)`

### Parameters
- **builderForValue** (TraceRmi.Addr.Builder) - The builder for the start address value.

### Returns
- `TraceRmi.RequestDisassemble.Builder` - The builder instance.

## mergeStart

### Description
Merges the start address field with a given address value.

### Method
`mergeStart(TraceRmi.Addr value)`

### Parameters
- **value** (TraceRmi.Addr) - The address value to merge.

### Returns
- `TraceRmi.RequestDisassemble.Builder` - The builder instance.

## clearStart

### Description
Clears the start address field.

### Method
`clearStart()`

### Returns
- `TraceRmi.RequestDisassemble.Builder` - The builder instance.

## getStartBuilder

### Description
Returns a builder for the start address field.

### Method
`getStartBuilder()`

### Returns
- `TraceRmi.Addr.Builder` - The builder for the start address.

## getStartOrBuilder

### Description
Returns an `OrBuilder` for the start address field.

### Method
`getStartOrBuilder()`

### Returns
- `TraceRmi.AddrOrBuilder` - The `OrBuilder` for the start address.
```

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

### getLineNumber

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

Gets the line number where the XML element starts.

```APIDOC
## getLineNumber

### Description
Gets the line number where the XML element starts.

### Method
public int getLineNumber()
```

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

### 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; false if help does not exist or is not working.

### Method
public boolean helpExists()

### Returns
- **boolean** - true if the help system has found the applications help content and has finished initializing
```

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

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

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

### getColumnNumber

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

Gets the column number where the XML element starts.

```APIDOC
## getColumnNumber

### Description
Gets the column number where the XML element starts.

### Method
public int getColumnNumber()
```

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

### Theme Initialization and Defaults

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

Methods for loading theme defaults and installing the theme in the GUI.

```APIDOC
## installInGui()

### Description
Installs the theme into the GUI.

### Method
`installInGui()`

### Return Type
`protected void`
```

```APIDOC
## loadApplicationDefaults()

### Description
Loads the default application theme settings.

### Method
`loadApplicationDefaults()`

### Return Type
`protected ApplicationThemeDefaults`
```

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

### getNormalizedToday

Source: https://ghidra.re/ghidra_docs/api/ghidra/util/DateUtils.html

Gets the current date normalized to the start of the day.

```APIDOC
## getNormalizedToday
public static Date getNormalizedToday()

### Description
Gets the current date normalized to the start of the day.

### Returns
- **Date** - The current date at midnight.
```

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

### getReferenceIterator

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

Gets an iterator over references starting with the specified fromAddr.

```APIDOC
## getReferenceIterator(Address startAddr)

### Description
Get an iterator over references starting with the specified fromAddr.

### Method
ReferenceIterator

### Parameters
* **startAddr** (Address) - The starting address for the iterator.
```

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

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

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

### 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
#### Path 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 Application Root Directories

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

Returns a collection of all root directories where the application is installed. This can include multiple locations if Ghidra is installed in a distributed manner.

```java
Collection<ResourceFile> rootDirs = Application.getApplicationRootDirectories();
```

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

### softStart(String... names)

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

Returns the next element, which must be a start element, and must be one of the supplied names (if provided). This method is very useful for starting a subtree, but differs from start(...) in that failures are soft. This means that if the next element isn't a start element, or doesn't match one of the optional provided names, null is returned (instead of raising an XmlException).

```APIDOC
## Method Details
### softStart
public XmlElement softStart(String... names)
Description copied from interface: `XmlPullParser`
Returns the next element, which must be a start element, and must be one of the supplied names (if provided). This method is very useful for starting a subtree, but differs from start(...) in that failures are soft. This means that if the next element isn't a start element, or doesn't match one of the optional provided names, null is returned (instead of raising an XmlException). 

Specified by:
    `softStart` in interface `XmlPullParser` 

Parameters:
    `names` - optional vararg Strings which start element name must be one of 

Returns:
    the next element (which is a start element) or null
```

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

### 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
## getStartSnap
public long getStartSnap()

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

Specified by:
    `getStartSnap` in interface `TraceReference` 

### Returns
- **long** - the starting snapshot

### See Also
- `TraceReference.getLifespan()`
```

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

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

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

### Constructor

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

Initializes a new instance of the TutorialScreenShotGenerator class.

```APIDOC
## Constructor

### TutorialScreenShotGenerator

```java
public TutorialScreenShotGenerator()
```

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

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

### install Method

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

Installs the editor kit to the specified JEditorPane.

```APIDOC
## install(JEditorPane c)

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

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

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

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

### labelForBlock

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

Gets the ASM label at the start of a block's translation.

```APIDOC
## labelForBlock

### Description
Get the label at the start of a block's translation.

### Parameters
- **block** (JitControlFlowModel.JitBlock) - the block

### Returns
the ASM label

### Method
`public org.objectweb.asm.Label labelForBlock(JitControlFlowModel.JitBlock block)`
```

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

### open

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

Opens the file system, performing necessary initializations.

```APIDOC
## open(TaskMonitor monitor)

### Description
Opens the file system.

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

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

### getBeginPosition

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

Gets the starting vertical pixel position of a given layout.

```APIDOC
## getBeginPosition

### Description
Returns the y position of the top of the i'th layout.

### Method
`getBeginPosition(int i)`

### Parameters
#### Path Parameters
- **i** (int) - Description: the index of the layout.

### Returns
- **int**: the position
```

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

### Constructor

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

Initializes a new EmulatorHelper instance.

```APIDOC
## Constructor

### EmulatorHelper

public EmulatorHelper(Program program)

Initializes a new EmulatorHelper instance with the given Program.
```

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

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

### Method
public String getAddressString(boolean showBlockName, boolean pad)

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

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

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

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

### installHelpService

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

Installs a custom HelpService for the application.

```APIDOC
## installHelpService(HelpService service)

### Description
Install the help service.

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

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

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

### setupJythonHomeDir

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

Sets up the Jython home directory, which is the parent directory containing the 'Lib' folder.

```APIDOC
## setupJythonHomeDir

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

### Method
static File

### Returns
The jython home directory.

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

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

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

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

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

### Method
`void run()`

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

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

### getStart

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

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

```APIDOC
## getStart()

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

### Method
CursorPosition
```

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

### 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
#### Path Parameters
- **address** (Address) - The initial program counter.

### Returns
- (Trace) - The resulting trace.

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

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

### getInstalledProcessorsHelpLocation Method

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`

### Method
protected HelpLocation
```

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

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

### Method
```java
public ghidra.app.emulator.FilteredMemoryState getFilteredMemState()
```

### Returns
the state
```

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

### init()

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

Initializes the domain object. This method performs essential setup operations for the domain object.

```APIDOC
## init()

### Description
Initializes the domain object. This method performs essential setup operations for the domain object.

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

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

### softStart(String... names)

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

Retrieves the next element, ensuring it is a start element and optionally matching against provided names. Unlike `start()`, this method returns null instead of throwing an XmlException if the element is not a start element or does not match the specified names, providing a softer failure mechanism.

```APIDOC
## softStart(String... names)

### Description
Returns the next element, which must be a start element, and must be one of the supplied names (if provided). This method is very useful for starting a subtree, but differs from start(...) in that failures are soft. This means that if the next element isn't a start element, or doesn't match one of the optional provided names, null is returned (instead of raising an XmlException).

### Parameters
- `names` (String...) - Optional vararg Strings which the start element name must be one of.

### Returns
XmlElement - The next element (which is a start element) or null.
```

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

### get (platform, snap, register, forward)

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

Gets the live units whose start addresses are within the given register for a specific platform, ordered by address.

```APIDOC
## get

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

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

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

### helpExists

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

Checks if the help system has been initialized properly and is functioning. Returns true if the help content is found and initialization is complete, otherwise returns false.

```APIDOC
## helpExists

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

### Returns
- **boolean**: true if the help system has found the applications help content and has finished initializing
```

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

### getFunctions (start, forward)

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

Gets an iterator over non-external functions starting from a specified address and ordered by entry address. The iteration direction is controlled by the 'forward' parameter.

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

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

### installHelpSearcher

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

Installs a searcher for the help system.

```APIDOC
## installHelpSearcher

### Description
Configures and installs a searcher for the help system, linking it with the `JHelp` component and `HelpModel`.

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

### Parameters
* **jHelp** (javax.help.JHelp) - The JHelp component.
* **helpModel** (javax.help.HelpModel) - The HelpModel to associate with the searcher.

### Overrides
`installHelpSearcher` in class `GHelpBroker`
```

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

### Method: getLifespan

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

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

### Method
`Lifespan getLifespan()`
```

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

### Install Extension from File

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/project/extensions/ExtensionInstaller.html

Installs a Ghidra extension from a given file. The file can be a zip archive or a directory containing an extension.properties file.

```APIDOC
## install

### Description
Installs the given extension file. This can be either an archive (zip) or a directory that contains an extension.properties file.

### Method
`public static boolean install(File file)`

### Parameters
#### Path Parameters
- **file** (File) - The extension to install.

### Returns
- **boolean** - true if the extension was successfully installed.
```

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

### getMemoryBlocksStartingWithName

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

Gets 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, within a given address set and program.

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

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

### Get Block

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/model/correlate/HashStore.html

Retrieves the basic block associated with a given starting address.

```APIDOC
## getBlock(Address addr)

### Description
Get the basic-block with the corresponding start Address.

### Parameters
#### Path Parameters
- **addr** (Address) - The starting address of the basic block.

### Returns
- **Block** - The basic block at the specified address, or null if not found.

### Method
Instance Method
```

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

### Initialization

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

Discovers available Go types.

```APIDOC
## Method Details

### init

```java
public void init(TaskMonitor monitor) throws IOException
```

Discovers available Go types.

**Parameters:**
* `monitor` - `TaskMonitor`

**Throws:**
* `IOException` - if error reading data or cancelled
```

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

### run Method

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

Executes the initialization logic.

```APIDOC
## run()

### Description
Executes the initialization logic.

### Method
`public void run()`

### Interface
Specified by: `run` in interface `Runnable`
```

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

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

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

### 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 specified address, ordered by entry address. Real functions are those with 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) - The starting address for the iteration.
- **forward** (boolean) - true to iterate in ascending address order, false for descending.

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

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

### StartInstructionValue Methods

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/processors/sleigh/expression/StartInstructionValue.html

Provides methods for decoding, comparing, and retrieving values related to the start instruction.

```APIDOC
## decode(Decoder decoder, SleighLanguage lang)

### Description
Decodes the StartInstructionValue using the provided decoder and Sleigh language.

### Method
`void decode(Decoder decoder, SleighLanguage lang)`

### Throws
`DecoderException`
```

```APIDOC
## equals(Object obj)

### Description
Checks if this StartInstructionValue is equal to another object.

### Method
`boolean equals(Object obj)`

### Overrides
`equals` in class `Object`
```

```APIDOC
## getValue(ParserWalker walker)

### Description
Retrieves the long value of the start instruction's address using the parser walker.

### Method
`long getValue(ParserWalker walker)`

### Throws
`MemoryAccessException`

### Specified by
`getValue` in class `PatternExpression`
```

```APIDOC
## hashCode()

### Description
Returns the hash code value for this StartInstructionValue.

### Method
`int hashCode()`

### Overrides
`hashCode` in class `Object`
```

```APIDOC
## maxValue()

### Description
Returns the maximum possible value for the start instruction address.

### Method
`long maxValue()`

### Specified by
`maxValue` in class `PatternValue`
```

```APIDOC
## minValue()

### Description
Returns the minimum possible value for the start instruction address.

### Method
`long minValue()`

### Specified by
`minValue` in class `PatternValue`
```

```APIDOC
## toString()

### Description
Returns a string representation of the StartInstructionValue.

### Method
`String toString()`

### Specified by
`toString` in class `PatternExpression`
```

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

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

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

### getDefaultFallThroughOffset

Source: https://ghidra.re/ghidra_docs/api/ghidra/trace/util/InstructionAdapterFromPrototype.html

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

```APIDOC
## getDefaultFallThroughOffset

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

### Method
`getDefaultFallThroughOffset()`

### Returns
int - default fall-through offset or zero (0) if instruction has no fall through
```

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

### initStarting

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

Called before the initialization of the userop.

```APIDOC
## initStarting

### Description
This protected method is invoked at the beginning of the userop's initialization process. It overrides the method from the superclass `AnnotatedPcodeUseropDefinition`.

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

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

### getBufferAt

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

Gets a view of a particular snap as a memory buffer at the specified start address.

```APIDOC
## getBufferAt

### Description
Get a view of a particular snap as a memory buffer.

### Method
`MemBuffer getBufferAt(long snap, Address start, ByteOrder byteOrder)`

### Parameters
- **snap** (long) - The snapshot ID.
- **start** (Address) - The starting address of the buffer.
- **byteOrder** (ByteOrder) - The byte order for the buffer.

### Returns
- **MemBuffer** - A memory buffer view.
```

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

### getRegisterVarnodeValue

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

Gets the value of a register at the start of an execution flow for a given instruction address.

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

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

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

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

### 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 to use.
- **config** (JitConfiguration) - The JIT configuration.
- **lookup** (MethodHandles.Lookup) - The method handles lookup object.
```

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

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

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

### getUndefinedDataAt(Address addr)

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

Get the Data (undefined) object that starts at the given address.

```APIDOC
## getUndefinedDataAt(Address addr)

### Description
Get the Data (undefined) object that starts at the given address.

### Parameters
* **addr** (Address) - The address to check for undefined data.

### Returns
a default DataObject if bytes exist at addr and nothing has been defined to exist there. Otherwise returns null.
```

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

### ConsoleApiNative.STARTUPINFOEX Constructor

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

Constructs a new STARTUPINFOEX object.

```APIDOC
## STARTUPINFOEX()

### Description
Constructs a new STARTUPINFOEX object.

### Constructor
`STARTUPINFOEX()`
```

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

### getUndefinedDataAfter

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

Gets the undefined Data object that starts at an address greater than the specified address.

```APIDOC
## getUndefinedDataAfter(Address addr, TaskMonitor monitor)

### Description
Get the undefined Data object that starts at an address that is greater than the given address.

### Parameters
* `addr` (Address) - The address to search after.
* `monitor` (TaskMonitor) - The task monitor for tracking progress.

### Returns
`Data` - The undefined Data object found after the specified address, or null if none is found.
```

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

### setupHeaderAddr

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

Sets up the Mach-O header in memory and returns its address.

```APIDOC
## setupHeaderAddr(Collection<SegmentCommand> segments)

### Description
Sets up the `MachHeader` in memory and returns its address.

### Parameters
* **segments** (Collection<SegmentCommand>) - A collection of segment commands.
```

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

### Get Label for Block

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

Retrieves the ASM label at the start of a block's translation.

```java
public org.objectweb.asm.Label labelForBlock(JitControlFlowModel.JitBlock block)
```

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

### main

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

Launches the Ghidra application.

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

### Description
Launches the given `GhidraLaunchable` specified in the first command line argument.

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

### Parameters
#### Path Parameters
- **args** (String[]) - Required - The first argument is the name of the `GhidraLaunchable` to launch. The remaining args get passed through to the class's `GhidraLaunchable.launch(ghidra.GhidraApplicationLayout, java.lang.String[])` method.

### Throws
- **Exception** - If there was a problem launching. See the exception's message for more details on what went wrong.
```

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

### Get Data Index

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/omf/omf51/Omf51Content.html

Returns the starting position of the data content within the BinaryReader.

```java
public long getDataIndex()
```

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

### getRootOffset

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

Gets the offset of this Data item from the start of the root data item in its hierarchy.

```APIDOC
## getRootOffset

### Description
Get the offset of this Data item from the start of the root data item of some hierarchy of structures.

### Returns
the offset
```

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

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

### Endpoint
N/A (Static method)

### Parameters
None

### Response
None
```

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

### Get Ghidra Installation Directory

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

Retrieves the root directory of the Ghidra installation. This method works across different operating modes, including development, batch testing, and release development.

```java
public static File getInstallationDirectory()
```

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

### init Method

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

Initializes the file handler with the provided context, offering access to essential services and information.

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

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

### Get Previous Application Settings Directories by Time

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

Retrieves a list of previous application settings directories, sorted by time, excluding the current installation and installations with different release names.

```APIDOC
## getPreviousApplicationSettingsDirsByTime

### Description
This is the same as `getUserSettingsDirsByTime()` except that it doesn't include the current installation or installations with different release names.

### Method
static

### Returns
- **List<File>**: the list of previous directories, sorted by time.
```

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

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