Package ghidra.app.decompiler.flatapi

Class FlatDecompilerAPI

java.lang.Object

ghidra.app.decompiler.flatapi.FlatDecompilerAPI

All Implemented Interfaces:

Disposable

public class FlatDecompilerAPI
extends Object
implements Disposable

Field Summary

Fields

Modifier and Type	Field	Description
protected DecompInterface	decompiler
protected FlatProgramAPI	flatProgramAPI

Constructor Summary

Constructors

Constructor	Description
FlatDecompilerAPI()	Initializes without a provided FlatProgramAPI instance...this must be set before using the FlatDecompilerAPI!
FlatDecompilerAPI(FlatProgramAPI flatProgramAPI)	Initializes with a provided FlatProgramAPI instance.

Method Summary

Modifier and Type	Method	Description
final String	decompile(Function function)	Decompiles the specified function and returns a string containing the decompilation.
final String	decompile(Function function, int timeoutSecs)	Decompiles the specified function and returns a string containing the decompilation.
void	dispose()	Disposes of the decompiler resources by calling currentDecompiler.dispose().
DecompInterface	getDecompiler()	Gets the actual decompiler (may be null if not initialized).
final void	initialize()	Initializes the decompiler instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

flatProgramAPI

protected FlatProgramAPI flatProgramAPI

decompiler

protected DecompInterface decompiler

Constructor Details

FlatDecompilerAPI

public FlatDecompilerAPI()

Initializes without a provided FlatProgramAPI instance...this must be set before using the FlatDecompilerAPI!

FlatDecompilerAPI

public FlatDecompilerAPI(FlatProgramAPI flatProgramAPI)

Initializes with a provided FlatProgramAPI instance.

Parameters:

flatProgramAPI - the FlatProgramAPI instance.

Method Details

getDecompiler

public DecompInterface getDecompiler()

Gets the actual decompiler (may be null if not initialized).

Returns:

the decompiler

decompile

public final String decompile(Function function)
                       throws Exception

Decompiles the specified function and returns a string containing the decompilation. This call does not impose a timeout.

Parameters:

function - the function to decompile

Returns:

a string containing the decompilation

Throws:

Exception

decompile

public final String decompile(Function function,
 int timeoutSecs)
                       throws Exception

Decompiles the specified function and returns a string containing the decompilation.

Parameters:

function - the function to decompile

timeoutSecs - maximum time allowed for decompile to complete.

Returns:

a string containing the decompilation

Throws:

Exception

initialize

public final void initialize()
                      throws Exception

Initializes the decompiler instance.

Throws:

Exception

dispose

public void dispose()

Disposes of the decompiler resources by calling currentDecompiler.dispose().

Specified by:

dispose in interface Disposable