Package ghidra.feature.vt.api.stringable

Class FunctionSignatureStringable

java.lang.Object
ghidra.feature.vt.api.util.Stringable
ghidra.feature.vt.api.stringable.FunctionSignatureStringable
All Implemented Interfaces:
docking.widgets.table.DisplayStringProvider, ghidra.util.classfinder.ExtensionPoint
public class FunctionSignatureStringable extends Stringable

  • Field Details

  • Constructor Details

    • FunctionSignatureStringable

      public FunctionSignatureStringable()

    • FunctionSignatureStringable

      public FunctionSignatureStringable(ghidra.program.model.listing.Function function)

  • Method Details

    • hasCustomStorage

      public boolean hasCustomStorage()

    • hasVarArgs

      public boolean hasVarArgs()

    • getDisplayString

      public String getDisplayString()
      Description copied from class: Stringable
      getDisplayString() returns a display string for this stringable.
      Note: It must not return a null. Instead it should return an empty string if it has no value.
      Specified by:
      getDisplayString in interface docking.widgets.table.DisplayStringProvider
      Specified by:
      getDisplayString in class Stringable

    • doConvertToString

      protected String doConvertToString(ghidra.program.model.listing.Program desiredProgram)
      Specified by:
      doConvertToString in class Stringable

    • doRestoreFromString

      protected void doRestoreFromString(String string, ghidra.program.model.listing.Program desiredProgram)
      Specified by:
      doRestoreFromString in class Stringable

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class Stringable

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in class Stringable

    • sameFunctionSignature

      public boolean sameFunctionSignature(ghidra.program.model.listing.Function function)

    • applyFunctionSignature

      public boolean applyFunctionSignature(ghidra.program.model.listing.Function toFunction, ghidra.framework.options.ToolOptions markupOptions, boolean forceApply) throws VersionTrackingApplyException
      Parameters:
      toFunction - the function whose signature we are setting.
      markupOptions - the options indicate what parts of the function signature to apply.
      forceApply - true indicates that the function signature should be applied even if the function signature, return type, parameter data type or parameter name options are set to "do not apply".
      Throws:
      VersionTrackingApplyException - if all desired parts of the function signature couldn't be applied.

    • applyParameterNames

      public boolean applyParameterNames(ghidra.program.model.listing.Function toFunction, ghidra.framework.options.ToolOptions markupOptions, boolean doNotReplaceWithDefaultNames, int originalToParamCount) throws VersionTrackingApplyException
      Parameters:
      toFunction - the function whose parameter names we are setting.
      markupOptions -
      doNotReplaceWithDefaultNames - flag indicating whether or not a parameter name can be replaced with a default name.
      originalToParamCount - original number of parameters in toFunction
      Throws:
      VersionTrackingApplyException