Package ghidra.program.model.graph

Interface GraphSelectionHandler

  • public interface GraphSelectionHandler
    Handler for selection/location event mappings from/to Ghidra and Renoir.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getGraphType()
      Get brief text describing the type of graph.
      boolean isActive()
      Check if the graph is the active graph window.
      boolean isEnabled()
      Check if the graph is enabled to receive/send events.
      java.lang.String locate​(java.lang.Object ghidraLocation)
      Translate a Ghidra location into a renoir location.
      void locate​(java.lang.String renoirLocation)
      Translate a Renoir Location into a Ghidra location.
      boolean notify​(java.lang.String notificationType)
      Handle Renoir notification.
      java.lang.String[] select​(java.lang.Object ghidraSelection)
      Translate a Ghidra selection into a renoir selection.
      void select​(java.lang.String[] renoirSelections)
      Translate a Renoir Selection into a Ghidra selection.
      void setActive​(boolean active)
      Set the handler to active/inactive based on whether the window it is handling is active or inactive.
      void setEnabled​(boolean enabled)
      Set the handler to enabled/disabled.

    • Method Detail

      • isActive

        boolean isActive()
        Check if the graph is the active graph window.
        Returns:
        true if this handler is active because the window it is handling is active

      • setActive

        void setActive​(boolean active)
        Set the handler to active/inactive based on whether the window it is handling is active or inactive.
        Parameters:
        active - true to activate the graph (may pop the graph window to the top)

      • isEnabled

        boolean isEnabled()
        Check if the graph is enabled to receive/send events.
        Returns:
        true if this handler is enabled.

      • setEnabled

        void setEnabled​(boolean enabled)
        Set the handler to enabled/disabled. This sets an enabled flag on this instance and has no affect on the other methods.
        Parameters:
        enabled - true to enable mapping selection/location events

      • select

        void select​(java.lang.String[] renoirSelections)
        Translate a Renoir Selection into a Ghidra selection.
        Parameters:
        renoirSelections - selection identifiers for selection within Renoir graph The Strings are the keys used for the graph vertex when generating the graph.

      • locate

        void locate​(java.lang.String renoirLocation)
        Translate a Renoir Location into a Ghidra location.
        Parameters:
        renoirLocation - string representing the location in renoir

      • select

        java.lang.String[] select​(java.lang.Object ghidraSelection)
        Translate a Ghidra selection into a renoir selection.
        Parameters:
        ghidraSelection - ghidra selection object
        Returns:
        set of strings that correspond to a Renoir selection The strings should be the key strings used when generating the graph.

      • locate

        java.lang.String locate​(java.lang.Object ghidraLocation)
        Translate a Ghidra location into a renoir location.
        Parameters:
        ghidraLocation - the location object to translate into a graph key string
        Returns:
        string representation of the location for Renoir. This should be the key of the graph vertex that represents the ghidraLocation object on the graph.

      • notify

        boolean notify​(java.lang.String notificationType)
        Handle Renoir notification.
        Parameters:
        notificationType - command from Renoir
        Returns:
        true if notification was handled and there is no need for any other handler to be notified.

      • getGraphType

        java.lang.String getGraphType()
        Get brief text describing the type of graph.
        Returns:
        String describing the graph.