Class GhidraState


  • public class GhidraState
    extends java.lang.Object
    Represents the current state of a Ghidra tool
    • Constructor Detail

      • GhidraState

        public GhidraState​(PluginTool tool,
                           Project project,
                           Program program,
                           ProgramLocation location,
                           ProgramSelection selection,
                           ProgramSelection highlight)
        Constructs a new Ghidra state.
        Parameters:
        tool - the current tool
        project - the current project
        program - the current program
        location - the current location
        selection - the current selection
        highlight - the current highlight
      • GhidraState

        public GhidraState​(GhidraState state)
    • Method Detail

      • getTool

        public PluginTool getTool()
        Returns the current tool.
        Returns:
        the current tool
      • getProject

        public Project getProject()
        Returns the current project.
        Returns:
        the current project
      • getCurrentProgram

        public Program getCurrentProgram()
        Returns the current program.
        Returns:
        the current program
      • setCurrentProgram

        public void setCurrentProgram​(Program program)
        Sets the current program.
        Parameters:
        program - the new program object
      • getCurrentAddress

        public Address getCurrentAddress()
        Returns:
        the address of the current location
      • setCurrentAddress

        public void setCurrentAddress​(Address address)
        If it differs, set the current location to the given address and fire a ProgramLocationPluginEvent.
        Parameters:
        address - the address
      • getCurrentLocation

        public ProgramLocation getCurrentLocation()
        Returns:
        the current location
      • getCurrentHighlight

        public ProgramSelection getCurrentHighlight()
        Returns:
        the currently highlighted selection
      • getCurrentSelection

        public ProgramSelection getCurrentSelection()
        Returns:
        the current selection
      • addEnvironmentVar

        public void addEnvironmentVar​(java.lang.String name,
                                      byte value)
      • addEnvironmentVar

        public void addEnvironmentVar​(java.lang.String name,
                                      short value)
      • addEnvironmentVar

        public void addEnvironmentVar​(java.lang.String name,
                                      int value)
      • addEnvironmentVar

        public void addEnvironmentVar​(java.lang.String name,
                                      long value)
      • addEnvironmentVar

        public void addEnvironmentVar​(java.lang.String name,
                                      float value)
      • addEnvironmentVar

        public void addEnvironmentVar​(java.lang.String name,
                                      double value)
      • addEnvironmentVar

        public void addEnvironmentVar​(java.lang.String name,
                                      java.lang.Object value)
      • removeEnvironmentVar

        public void removeEnvironmentVar​(java.lang.String name)
      • getEnvironmentVar

        public java.lang.Object getEnvironmentVar​(java.lang.String name)
      • addParameter

        public void addParameter​(java.lang.String key,
                                 java.lang.String label,
                                 int type,
                                 java.lang.Object defaultValue)
      • displayParameterGatherer

        public boolean displayParameterGatherer​(java.lang.String title)
      • getEnvironmentNames

        public java.util.Set<java.lang.String> getEnvironmentNames()