Ghidra Headless Analyzer

https://ghidra.re/ghidra_docs/
Admin
Ghidra Headless Analyzer is a utility class for performing automated, command-line driven analysis...
Tokens:27,660,106
Snippets:264,589
Trust Score:7.9
Update:19 hours ago
Show doc for...
Tokens:
Raw
### setUp

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

Sets up the test environment. Throws an exception if setup fails.

```APIDOC
## setUp

### Description
Sets up the test environment. Throws an exception if setup fails.

### Method
setUp

### Signature
public void setUp() throws Exception

### Throws
- Exception - if setup fails
```

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

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

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

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

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

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

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

### Parameters
- **snap** (long) - The snap during which the units must be alive.
- **start** (Address) - The minimum (forward) or maximum (backward) start address, inclusive.
- **forward** (boolean) - True to order the units by increasing address, false for descending.

### Returns
An iterable of units.
```

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

### getClientAuthenticator()

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/client/ClientUtil.html

Gets the currently installed client authenticator. If none is installed, triggers installation of a default instance.

```APIDOC
## getClientAuthenticator()

### Description
Get the currently installed client authenticator. If one has not been installed, this will trigger the installation of a default instance.

### Method
public static ClientAuthenticator getClientAuthenticator()

### Parameters
None

### Returns
ClientAuthenticator - The current client authenticator.
```

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

### prepareStartupInfo()

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Method in class ghidra.pty.windows.ConPtyChild. Prepares startup information for the pseudo-terminal.

```APIDOC
## prepareStartupInfo()

### Description
Method in class `ghidra.pty.windows.ConPtyChild`. Prepares startup information for the pseudo-terminal.

### Method
`prepareStartupInfo`

### Signature
`public ??? prepareStartupInfo()`

### Parameters
None.

### Returns
- (unspecified) - The prepared startup information.

### Containing Class
`ghidra.pty.windows.ConPtyChild`
```

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

### install

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

Static method to install the help service. This is the primary entry point for initializing the help system.

```APIDOC
## install

### Description
Installs the help service. This is a static method that initializes the help system.

### Method
install

### Signature
public static void install()

### Parameters
None

### Returns
void
```

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

### getFunctions(Address start, boolean forward)

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

Get an iterator over all functions starting at address.

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

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

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

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

### Returns
- **FunctionIterator** - An iterator over functions starting at the given address.
```

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

### getGuidStream()

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

Gets the GUID stream.

```APIDOC
## getGuidStream()

### Description
Gets the GUID stream.

### Returns
CliStreamGuid - The GUID stream.

```

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

### TestHelpService.install(URL)

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Static method in class docking.help.TestHelpService. Installs a help URL.

```APIDOC
## TestHelpService.install(URL)

### Description
Installs a help URL.

### Method
install(URL)

### Signature
public static void install(URL url)

### Class
docking.help.TestHelpService

### Parameters
- **url** (URL) - Required - The URL to install.

### Returns
void
```

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

### prepareStartupInfo()

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

Prepares the startup information for the process.

```APIDOC
## Method: prepareStartupInfo

### Description
Prepares the startup information for the process.

### Signature
`protected ConsoleApiNative.STARTUPINFOEX prepareStartupInfo()`

### Returns
- **ConsoleApiNative.STARTUPINFOEX** - The prepared startup information.

```

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

### getData(int start, int end)

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

Get an array of data items that begin at or after start up to end.

```APIDOC
## getData(int start, int end)

### Description
Get an array of data items that begin at or after start up to end.

### Method Signature
`Data[] getData(int start, int end)`

### Parameters
- **start** (int) - Required - The starting offset.
- **end** (int) - Required - The ending offset.

### Returns
- **Data[]** - An array of data items that begin at or after start up to end.
```

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

### install(URL masterHelpSetUrl)

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

Installs a help set from the given master help set URL. This is a static method that configures the help system with the specified URL.

```APIDOC
## install(URL masterHelpSetUrl)

### Description
Installs a help set from the given master help set URL. This static method configures the help system with the specified URL.

### Method
public static void install(URL masterHelpSetUrl)

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

### Return Type
void
```

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

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

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

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

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

### 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
- **factory** (AddressFactory) - Required - The factory.
- **start** (Address) - Required - The start (or end) address.
- **forward** (boolean) - Required - True for all after, false for all before.

### Returns
- **AddressSetView** - The address set.
```

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

### get(long, AddressSetView, boolean) - TraceBaseCodeUnitsView

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Gets the live units whose start addresses are in the given set.

```APIDOC
## get(long, AddressSetView, boolean)

### Description
Get the live units whose start addresses are in the given set.

### Method
`get(long snap, AddressSetView set, boolean forward)`

### Parameters
- **snap** (long) - The snapshot key.
- **set** (AddressSetView) - The set of addresses.
- **forward** (boolean) - Whether to iterate forward.

### Returns
- The live units in the set.
```

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

### install()

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

Static method to install the Ghidra help service.

```APIDOC
## install()

### Description
Installs the Ghidra help service.

### Method
install

### Signature
public static void install()

### Parameters
None

### Returns
void
```

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

### getDataIterator(Address start, boolean forward)

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

Protected method to get an iterator over data starting at a given address.

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

### Description
Protected method to get an iterator over data starting at a given address.

### Method Signature
`protected Iterator<TraceData> getDataIterator(Address start, boolean forward)`

### Parameters
- **start** (Address) - Required - The starting address for the iteration.
- **forward** (boolean) - Required - If true, iterate forward; if false, iterate backward.

### Returns
- **Iterator<TraceData>** - An iterator over TraceData starting at the given address.
```

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

### setUp() - ProcessorEmulatorTestAdapter

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Method in class ghidra.test.processors.support.ProcessorEmulatorTestAdapter. Sets up the test environment.

```APIDOC
## setUp()

### Description
Method in class ghidra.test.processors.support.ProcessorEmulatorTestAdapter. Sets up the test environment.

### Method
setUp

### Parameters
None

### Class
ghidra.test.processors.support.ProcessorEmulatorTestAdapter
```

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

### getStart

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/assembler/sleigh/sem/AssemblyContextGraph.Edge.html

Gets the start, or tail, of the edge. In the edge x -> y, x is the start. This method is specified by the GEdge interface.

```APIDOC
## getStart

### Description
Gets the start, or tail, of the edge. In the edge x -> y, x is the start. This method is specified by the GEdge interface.

### Method
public AssemblyContextGraph.Vertex getStart()

### Returns
AssemblyContextGraph.Vertex - The start vertex.
```

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

### setUp() - AbstractScreenShotGenerator

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Method in class help.screenshot.AbstractScreenShotGenerator. Sets up the screenshot generator.

```APIDOC
## setUp()

### Description
Method in class help.screenshot.AbstractScreenShotGenerator. Sets up the screenshot generator.

### Method
setUp

### Parameters
None

### Class
help.screenshot.AbstractScreenShotGenerator
```

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

### getStartSnap()

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

Get the starting snap of the lifespan.

```APIDOC
## getStartSnap()

### Description
Get the starting snap of the lifespan.

### Method
`long getStartSnap()`

### Returns
- **long** - The starting snap.

```

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

### setupJythonHomeDir()

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

Sets up the Jython home directory, which contains the 'Lib' directory. Returns the home directory as a File object. Throws IOException if there is a disk-related problem.

```APIDOC
## setupJythonHomeDir()

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

### Method
public static File setupJythonHomeDir() throws IOException

### Returns
- **File** - The jython home directory.

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

```

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

### installHelpService(HelpService service)

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

Static method to install a help service. Takes a HelpService parameter.

```APIDOC
## installHelpService(HelpService service)

### Description
Installs the given help service.

### Method
Static method

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

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

```

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

### getHighlightProviders

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

Gets all ListingHighlightProviders installed on this FormatManager.

```APIDOC
## getHighlightProviders

### Description
Gets all ListingHighlightProviders installed on this FormatManager via the addHighlightProvider(ListingHighlightProvider) method.

### Method
public List<ListingHighlightProvider> getHighlightProviders()

### Returns
- **List<ListingHighlightProvider>** - all ListingHighlightProviders installed on this FormatManager.
```

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

### getAddress()

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/macho/dyld/DyldCacheMappingInfo.html

Gets the address of the start of the mapping.

```APIDOC
## getAddress()

### Description
Gets the address of the start of the mapping.

### Method
public long getAddress()

### Returns
- `long` - The address of the start of the mapping.
```

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

### start()

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/plugintool/StandAloneApplication.html

Starts the application.

```APIDOC
## Method: start

### Description
Starts the application.

### Method
start

### Signature
void start()

### Parameters
None

### Returns
void
```

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

### getAddress()

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/macho/dyld/DyldCacheMappingAndSlideInfo.html

Gets the address of the start of the mapping.

```APIDOC
## getAddress()

### Description
Gets the address of the start of the mapping.

### Method
`long getAddress()`

### Returns
- **long** - The address of the start of the mapping.
```

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

### setup(String message)

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/script/MultipleOptionsDialog.html

Initializes the dialog with the given message. Called internally during construction.

```APIDOC
## Method

### Signature
`protected void setup(String message)`

### Description
Sets up the dialog components with the provided message. This method is called during construction and can be overridden to customize the dialog layout.

### Parameters
- **message** (String) - The message to display in the dialog.

### Returns
void

### Usage Example
```java
@Override
protected void setup(String message) {
    super.setup(message);
    // additional setup
}
```
```

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

### getAddress()

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/macho/dyld/DyldCacheImage.html

Gets the address of the start of the image.

```APIDOC
## getAddress()

### Description
Gets the address of the start of the image.

### Method
long getAddress()

### Returns
The address of the start of the image.
```

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

### ExtensionInstaller.install(File)

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Static method in class ghidra.framework.project.extensions.ExtensionInstaller. Installs the given extension file.

```APIDOC
## ExtensionInstaller.install(File)

### Description
Installs the given extension file.

### Method
install(File)

### Signature
public static void install(File file)

### Class
ghidra.framework.project.extensions.ExtensionInstaller

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

### Returns
void
```

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

### getLSDAAddress

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/exceptionhandlers/gcc/RegionDescriptor.html

Gets the address of the start of the LSDA.

```APIDOC
## getLSDAAddress

### Description
Gets the address of the start of the LSDA.

### Method
public Address getLSDAAddress(Address addr)

### Parameters
- **addr** (Address) - the LSDA address.

### Returns
- **Address** - the LSDA address.

```

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

### start()

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/plugintool/StandAloneApplication.html

Starts the standalone application.

```APIDOC
## start()

### Description
Starts the standalone application.

### Method
Instance Method

### Signature
`public void start()`

```

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

### launch(GhidraApplicationLayout layout, String[] args)

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

Entry point for buildGhidraJar.bat.

```APIDOC
## Method: launch(GhidraApplicationLayout layout, String[] args)

### Description
Entry point for buildGhidraJar.bat. This method is called to start the JAR building process.

### Signature
`public void launch(GhidraApplicationLayout layout, String[] args)`

### Parameters
- **layout** (GhidraApplicationLayout) - Required - The application layout.
- **args** (String[]) - Required - Command-line arguments.

### Returns
void.
```

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

### getStart()

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/assembler/sleigh/sem/AssemblyContextGraph.Edge.html

Gets the start, or tail, of the edge.

```APIDOC
## getStart()

### Description
Gets the start, or tail, of the edge.

### Method
getStart

### Signature
`AssemblyContextGraph.Vertex getStart()`

### Returns
- `AssemblyContextGraph.Vertex` - The start vertex of the edge.
```

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

### getStart

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/assembler/sleigh/grammars/AbstractAssemblyGrammar.html

Gets the start symbol for the grammar.

```APIDOC
## getStart

### Description
Gets the start symbol for the grammar.

### Method
getStart

### Returns
NT - the start symbol
```

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

### void start()

Source: https://ghidra.re/ghidra_docs/api/generic/timer/ExpiringSwingTimer.html

Starts the timer.

```APIDOC
## void start()

### Description
Starts the timer.

### Usage Example
```java
timer.start();
```
```

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

### get(long, Register, boolean) - TraceBaseCodeUnitsView

Source: https://ghidra.re/ghidra_docs/api/index-all.html

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

```APIDOC
## get(long, Register, boolean)

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

### Method
`get(long snap, Register register, boolean forward)`

### Parameters
- **snap** (long) - The snapshot key.
- **register** (Register) - The register.
- **forward** (boolean) - Whether to iterate forward.

### Returns
- The live units in the register.
```

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

### Method: installNavigation(GoToService goToService)

Source: https://ghidra.re/ghidra_docs/api/ghidra/util/table/GhidraFilterTable.html

Installs navigation support using the provided GoToService.

```APIDOC
## Method: installNavigation(GoToService goToService)

### Description
Installs navigation support using the provided GoToService.

### Method
void installNavigation(GoToService goToService)

### Parameters
- **goToService** (GoToService) - Required - The service to use for navigation.

### Returns
- **void** - This method does not return a value.

### Usage Example
```java
filterTable.installNavigation(goToService);
```
```

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

### get(long, Address, Address, boolean)

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

Gets all code units between the given start and end addresses at the given snap.

```APIDOC
## get(long, Address, Address, boolean)

### Description
Gets all code units between the given start and end addresses at the given snap.

### Method
get

### Parameters
- **snap** (long) - The snap at which to get code units.
- **start** (Address) - The start address.
- **end** (Address) - The end address.
- **forward** (boolean) - Whether to iterate forward.

### Returns
Collection of code units in the range.
```

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

### install(ExtensionDetails extension, File file, TaskMonitor monitor)

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

Installs a Ghidra extension from a file or directory. The method takes the extension details, the file to install, and a task monitor for progress reporting.

```APIDOC
## install(ExtensionDetails extension, File file, TaskMonitor monitor)

### Description
Installs a Ghidra extension from a file or directory. The method takes the extension details, the file to install, and a task monitor for progress reporting.

### Method
`public static boolean install(ExtensionDetails extension, File file, TaskMonitor monitor)`

### Parameters
- **extension** (ExtensionDetails) - Required - The extension details.
- **file** (File) - Required - The file or directory to install.
- **monitor** (TaskMonitor) - Required - The task monitor for progress reporting.

### Returns
- **boolean** - true if the installation was successful.
```

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

### setup(String message)

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/script/MultipleOptionsDialog.html

Protected method to set up the dialog with the given message.

```APIDOC
## Method

### Signature
`protected void setup(String message)`

### Description
Sets up the dialog with the provided message. This method is called during initialization.

### Parameters
- **message** (String) - The message to display in the dialog.
```

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

### getFunctions(Address start, boolean forward)

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

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

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

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

### Method
`getFunctions`

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

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

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

### installHomeButton()

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/plugintool/PluginTool.html

Installs the home button.

```APIDOC
## installHomeButton()

### Description
Installs the home button.

### Method
installHomeButton

### Returns
- **void** - This method does not return a value.

```

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

### getFunctions(Address start, boolean forward)

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

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

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

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

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

### Return Type
`FunctionIterator`

### Parameters
- **start** (Address) - Required - The starting address for iteration.
- **forward** (boolean) - Required - If true, iterate forward from the start address; otherwise, backward.

### Returns
An iterator over non-external functions starting at the given address.
```

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

### getStartAddress() - ghidra.program.util.InteriorSelection

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Get the start address of this selection.

```APIDOC
## getStartAddress()

### Description
Get the start address of this selection.

### Method
`getStartAddress()`

### Class
`ghidra.program.util.InteriorSelection`

### Returns
- **Address** - The start address of this selection.
```

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

### StandAloneApplication.start()

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Method in class ghidra.framework.plugintool.StandAloneApplication that starts the application.

```APIDOC
## StandAloneApplication.start()

### Description
Method in class ghidra.framework.plugintool.StandAloneApplication.

### Class
ghidra.framework.plugintool.StandAloneApplication

### Method
start()

```

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

### install(JEditorPane c)

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

Installs this editor kit on the specified JEditorPane, configuring it for rendering help content.

```APIDOC
## install(JEditorPane c)

### Description
Installs this editor kit on the specified JEditorPane, configuring it for rendering help content.

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

### Parameters
- **c** (JEditorPane) - Required - The editor pane to install this kit on.
```

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

### getAddress() - DyldCacheMappingInfo

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Gets the address of the start of the mapping.

```APIDOC
## getAddress()

### Description
Gets the address of the start of the mapping.

### Method
`getAddress()`

### Return Type
Address

### Class
`ghidra.app.util.bin.format.macho.dyld.DyldCacheMappingInfo`
```

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

### helpExists()

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

Checks if the help system has been initialized properly. Returns true if help is available and working, false otherwise.

```APIDOC
## helpExists()

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

### Method
helpExists

### Signature
`boolean helpExists()`

### Parameters
None

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

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

### getAddress() - DyldCacheMappingAndSlideInfo

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Gets the address of the start of the mapping.

```APIDOC
## getAddress()

### Description
Gets the address of the start of the mapping.

### Method
`getAddress()`

### Return Type
Address

### Class
`ghidra.app.util.bin.format.macho.dyld.DyldCacheMappingAndSlideInfo`
```

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

### static void initializeGhidra()

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/examiner/ProgramExaminer.html

Initializes Ghidra environment.

```APIDOC
## Method initializeGhidra()

### Description
Initializes Ghidra environment.

### Method Signature
`static void initializeGhidra()`

### Return Type
void

```

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

### getClientAuthenticator()

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/client/ClientUtil.html

Gets the currently installed client authenticator.

```APIDOC
## getClientAuthenticator()

### Description
Gets the currently installed client authenticator.

### Method
static ClientAuthenticator

### Signature
`public static ClientAuthenticator getClientAuthenticator()`

### Parameters
None

### Returns
- **ClientAuthenticator** - The currently installed client authenticator.
```

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

### getGuidStream()

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

Gets the GUID stream from the metadata root.

```APIDOC
## getGuidStream()

### Description
Gets the GUID stream from the metadata root.

### Method
`getGuidStream()`

### Return Type
`CliStreamGuid` (inferred from context)

### Parameters
None

### Returns
The GUID stream object.
```

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

### setupOptions(JythonPlugin plugin, Options options)

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

Sets up Jython code completion Options.

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

### Description
Sets up Jython code completion Options.

### Method
static

### Signature
`setupOptions(ghidra.jython.JythonPlugin plugin, ghidra.framework.options.Options options)`

### Parameters
- **plugin** (JythonPlugin) - Required - The Jython plugin instance.
- **options** (Options) - Required - The options object to configure.

### Returns
- void
```

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

### setupJythonHomeDir()

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

Sets up the jython home directory. This method takes no parameters and returns a File object representing the home directory.

```APIDOC
## setupJythonHomeDir()

### Description
Sets up the jython home directory.

### Method
static File setupJythonHomeDir()

### Parameters
None

### Returns
- **File** - The jython home directory.

```

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

### getFileOffset()

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/macho/dyld/DyldCacheMappingInfo.html

Gets the file offset of the start of the mapping.

```APIDOC
## getFileOffset()

### Description
Gets the file offset of the start of the mapping.

### Method
public long getFileOffset()

### Returns
- `long` - The file offset of the start of the mapping.
```

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

### installEditKeyBinding()

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

Installs the key binding for editing the table.

```APIDOC
## installEditKeyBinding()

### Description
Installs the key binding for editing the table.

### Method
`protected void installEditKeyBinding()`

```

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

### getFileOffset()

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/macho/dyld/DyldCacheMappingAndSlideInfo.html

Gets the file offset of the start of the mapping.

```APIDOC
## getFileOffset()

### Description
Gets the file offset of the start of the mapping.

### Method
`long getFileOffset()`

### Returns
- **long** - The file offset of the start of the mapping.
```

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

### start(instance method)

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

Defines an instance method by starting a method definition with the given owner, class visitor, access flags, name, and descriptor.

```APIDOC
## start(instance method)

### Description
Defines an instance method by starting a method definition with the given owner, class visitor, access flags, name, and descriptor.

### Method
static <MR extends Types.BType, OT, N extends Emitter.Next> Methods.ObjDef<MR,OT,N> start(Types.TRef<OT> owner, org.objectweb.asm.ClassVisitor cv, int access, String name, Methods.MthDesc<MR,N> desc)

### Parameters
- **owner** (Types.TRef<OT>) - Required - The owner type reference.
- **cv** (org.objectweb.asm.ClassVisitor) - Required - The ASM class visitor.
- **access** (int) - Required - Access flags for the method.
- **name** (String) - Required - The method name.
- **desc** (Methods.MthDesc<MR,N>) - Required - The method descriptor.

### Returns
- **Methods.ObjDef<MR,OT,N>** - The method definition object.

```

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

### long getAddress()

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/macho/dyld/DyldCacheMappingInfo.html

Gets the address of the start of the mapping.

```APIDOC
## long getAddress()

### Description
Gets the address of the start of the mapping.

### Returns
- **long** - The address of the start of the mapping.

```

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

### installHomeButton()

Source: https://ghidra.re/ghidra_docs/api/ghidra/framework/plugintool/PluginTool.html

Installs the home button for the tool.

```APIDOC
## installHomeButton()

### Description
Installs the home button for the tool.

### Method
installHomeButton

### Signature
protected void installHomeButton()
```

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

### Method: getStartsCount()

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/util/bin/format/macho/commands/chained/DyldChainedStartsOffsets.html

Gets the number of starts in the structure.

```APIDOC
## Method: getStartsCount()

### Description
Gets the starts count.

### Signature
`public int getStartsCount()`

### Returns
The starts count.
```

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

### getMinAddress()

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

Get the starting address for this code unit.

```APIDOC
## getMinAddress()

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

### Method
`Address getMinAddress()`

### Returns
- **Address** - The starting address.

```

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

### start()

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

Starts the API.

```APIDOC
## start()

### Description
Starts the API.

### Method
start

### Parameters
None

### Returns
void
```

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

### HeadlessGhidraApplicationConfiguration.initializeApplication()

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Initializes the headless Ghidra application configuration.

```APIDOC
## HeadlessGhidraApplicationConfiguration.initializeApplication()

### Description
Initializes the headless Ghidra application configuration.

### Method
initializeApplication()

### Class
ghidra.framework.HeadlessGhidraApplicationConfiguration

### Returns
void
```

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

### getLPStartAddress()

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

Gets the landing pad start address.

```APIDOC
## getLPStartAddress()

### Description
Gets the landing pad start address.

### Method
`getLPStartAddress()`

### Return Type
`Address`

```

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

### startOfFile(Path)

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Method in class ReferenceTagProcessor.

```APIDOC
## Method: startOfFile(Path)

### Description
Method in class help.validator.ReferenceTagProcessor.

### Signature
`startOfFile(java.nio.file.Path)`
```

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

### getStartName

Source: https://ghidra.re/ghidra_docs/api/ghidra/app/plugin/assembler/sleigh/grammars/AbstractAssemblyGrammar.html

Gets the name of the start symbol for the grammar.

```APIDOC
## getStartName

### Description
Gets the name of the start symbol for the grammar.

### Method
getStartName

### Returns
String - the name of the start symbol
```

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

### iterator

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

Get an iterator over tokens starting with this ClangToken.

```APIDOC
## iterator(boolean forward)

### Description
Get an iterator over tokens starting with this ClangToken.

### Method
`Iterator<ClangToken> iterator(boolean forward)`

### Parameters
- **forward** (boolean) - Required - Direction of iteration: true for forward, false for backward.

### Returns
- **Iterator<ClangToken>** - An iterator over tokens starting with this token.
```

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

### HeadlessBSimApplicationConfiguration.initializeApplication()

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Initializes the application configuration for headless BSim.

```APIDOC
## HeadlessBSimApplicationConfiguration.initializeApplication()

### Description
Initializes the application configuration for headless BSim.

### Method
initializeApplication()

### Class
ghidra.features.bsim.query.ingest.HeadlessBSimApplicationConfiguration

### Returns
void
```

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

### get(long, Address, Address, boolean) - TraceBaseCodeUnitsView

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Gets the live units whose start addresses are within the specified range.

```APIDOC
## get(long, Address, Address, boolean)

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

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

### Parameters
- **snap** (long) - The snapshot key.
- **start** (Address) - The start address of the range.
- **end** (Address) - The end address of the range.
- **forward** (boolean) - Whether to iterate forward.

### Returns
- The live units in the range.
```

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

### installInGui()

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Method in class generic.theme.ThemeManager. Installs the theme in the GUI.

```APIDOC
## installInGui()

### Description
Installs the theme in the GUI.

### Method
installInGui()

### Class
generic.theme.ThemeManager

### Parameters
None

### Returns
void
```

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

### installEditKeyBinding()

Source: https://ghidra.re/ghidra_docs/api/index-all.html

Method in class GTable. Installs the edit key binding.

```APIDOC
## installEditKeyBinding()

### Description
Method in class GTable. Installs the edit key binding.

### Class
docking.widgets.table.GTable

### Method
installEditKeyBinding()

```

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

### getAddressKeyIterator(Address start, boolean before)

Source: https://ghidra.re/ghidra_docs/api/ghidra/program/database/properties/PropertyMapDB.html

Gets an iterator over the long address keys which contain a property value, starting from the given address.

```APIDOC
## getAddressKeyIterator(Address start, boolean before)

### Description
Gets an iterator over the long address keys which contain a property value, starting from the given address.

### Method
AddressKeyIterator getAddressKeyIterator(Address start, boolean before)

### Parameters
- **start** (Address) - The starting address for the iteration.
- **before** (boolean) - If true, the iterator will start before the given address.

### Returns
AddressKeyIterator - An iterator over the long address keys.
```
Tokens:
Raw