Package ghidra.app.decompiler

# Interface DecompilerLocation

All Known Implementing Classes:
  `DefaultDecompilerLocation`, `FunctionNameDecompilerLocation`, `VariableDecompilerLocation`

public interface DecompilerLocation
Represents a location in the Decompiler. This interface allows the Decompiler to subclass more general `ProgramLocation`s while adding more detailed Decompiler information.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getCharPos()`
  Returns the character position.
  `DecompileResults`
  `getDecompile()`
  Results from the decompilation
  `Address`
  `getFunctionEntryPoint()`
  `int`
  `getLineNumber()`
  Returns the line number.
  `ClangToken`
  `getToken()`
  C text token at the current cursor location
  `String`
  `getTokenName()`
  Returns the name of the token for the current location.

- ## Method Details

  - ### getFunctionEntryPoint

    Address getFunctionEntryPoint()

  - ### getDecompile

    DecompileResults getDecompile()
    Results from the decompilation
    Returns:
      C-AST, DFG, and CFG object. null if there are no results attached to this location

  - ### getToken

    ClangToken getToken()
    C text token at the current cursor location
    Returns:
      token at this location, could be null if there are no decompiler results

  - ### getTokenName

    String getTokenName()
    Returns the name of the token for the current location.
    Returns:
      the name of the token for the current location

  - ### getLineNumber

    int getLineNumber()
    Returns the line number.
    Returns:
      the line number

  - ### getCharPos

    int getCharPos()
    Returns the character position.
    Returns:
      the character position