Package ghidra.app.util.viewer.listingpanel

Interface ListingModel

All Known Implementing Classes:
EmptyListingModel, ListingModelConverter, ProgramBigListingModel
public interface ListingModel
Model displaying program data in a FieldPanel

  • Field Details

    • FUNCTION_POINTER_OPTION_GROUP_NAME

      static final String FUNCTION_POINTER_OPTION_GROUP_NAME
      See Also:

    • DISPLAY_EXTERNAL_FUNCTION_POINTER_OPTION_NAME

      static final String DISPLAY_EXTERNAL_FUNCTION_POINTER_OPTION_NAME
      See Also:

    • DISPLAY_NONEXTERNAL_FUNCTION_POINTER_OPTION_NAME

      static final String DISPLAY_NONEXTERNAL_FUNCTION_POINTER_OPTION_NAME
      See Also:

  • Method Details

    • getAddressSet

      AddressSetView getAddressSet()

    • getAddressAfter

      Address getAddressAfter(Address address)

    • getAddressBefore

      Address getAddressBefore(Address address)

    • getLayout

      Layout getLayout(Address address, boolean isGapAddress)

    • getMaxWidth

      int getMaxWidth()
      Returns the width of the longest layout this model can produce..
      Returns:
      the width of the longest layout this model can produce.

    • isOpen

      boolean isOpen(Data data)
      Returns true if the data is open
      Parameters:
      data - the data to check
      Returns:
      true if the data is open

    • toggleOpen

      void toggleOpen(Data data)
      Changes the open state of the given data (open -> closes; closed-> open).
      Parameters:
      data - the data to open

    • setFunctionVariablesOpen

      void setFunctionVariablesOpen(Address FunctionAddress, boolean open)
      Sets whether or not to display function variables for the function at the given address.
      Parameters:
      FunctionAddress - the address of the function
      open - if true, the variables are displayed, otherwise they are hidden

    • areFunctionVariablesOpen

      boolean areFunctionVariablesOpen(Address FunctionAddress)
      Checks if the function variables are being displayed at the given address
      Parameters:
      FunctionAddress - the address of the function
      Returns:
      true if the variables are being displayed for the function at the given address

    • setAllFunctionVariablesOpen

      void setAllFunctionVariablesOpen(boolean open)
      Sets the display of variables for all functions. This basically sets the default state, but the state can be overridden for individual functions. Changing this value erases all individually set values.
      Parameters:
      open - if true, show function variables

    • openData

      boolean openData(Data data)
      Opens the given data, but not any sub-components.
      Parameters:
      data - the data to open
      Returns:
      true if the data was opened (will return false if the data is already open or has no children)

    • openAllData

      void openAllData(Data data, TaskMonitor monitor)
      Recursively open the given data and its sub-components.
      Parameters:
      data - the data to open
      monitor - the task monitor

    • openAllData

      void openAllData(AddressSetView addresses, TaskMonitor monitor)
      Opens all data found within the given addresses. Each data is fully opened.
      Parameters:
      addresses - the range of addresses to search for data
      monitor - the task monitor

    • closeData

      void closeData(Data data)
      Closes the given data, but not any sub-components.
      Parameters:
      data - the data to close

    • closeAllData

      void closeAllData(Data data, TaskMonitor monitor)
      Recursively close the given data and its sub-components.
      Parameters:
      data - the data to close
      monitor - the task monitor

    • closeAllData

      void closeAllData(AddressSetView addresses, TaskMonitor monitor)
      Closes all data found within the given addresses. Each data is fully closed.
      Parameters:
      addresses - the range of addresses to search for data
      monitor - the task monitor

    • addListener

      void addListener(ListingModelListener listener)
      Adds a listener for changes to this model.
      Parameters:
      listener - the listener to be notified

    • removeListener

      void removeListener(ListingModelListener listener)
      Removes a listener from those being notified of model changes.
      Parameters:
      listener - the listener to be removed

    • getProgram

      Program getProgram()
      Returns the program being displayed by this model..
      Returns:
      the program being displayed by this model.

    • isClosed

      boolean isClosed()
      Returns true if the program being displayed by this listing has been closed (and therefor the model is invalid.).
      Returns:
      true if the program being displayed by this listing has been closed (and therefor the model is invalid.)

    • setFormatManager

      void setFormatManager(FormatManager formatManager)
      Sets the FormatManager for this model which determines the layout of the fields.
      Parameters:
      formatManager - the new FormatManager to use

    • dispose

      void dispose()
      Disposes this model

    • adjustAddressSetToCodeUnitBoundaries

      AddressSet adjustAddressSetToCodeUnitBoundaries(AddressSet addressSet)
      Adjusts each range in the given address set to be on code unit boundaries.
      Parameters:
      addressSet - the address set to be adjusted
      Returns:
      a new AddressSet where each range is on a code unit boundary

    • copy

      ListingModel copy()
      Makes a copy of this model.
      Returns:
      a copy of this model.