Package net.emustudio.emulib.runtime

Interface ApplicationApi

  • @ThreadSafe
public interface ApplicationApi
    emuStudio application API.

    Plugins can use it for the communication with emuStudio.

    • Field Detail

      • UNAVAILABLE

        static final ApplicationApi UNAVAILABLE
        "Unavailable" instance of ApplicationApi.

        It means that all methods return dummy or null values.

        The instance might be useful when creating plugin object without emuStudio (e.g. a plugin wants to support command-line interface).

    • Method Detail

      • getDebuggerTable

        DebuggerTable getDebuggerTable()
        Get debugger table.
        Returns:
        debugger table in emuStudio.

      • getContextPool

        ContextPool getContextPool()
        Get context pool.

        Context pool is used for registration and obtaining plugin contexts, which are used in plugin communication.

        Returns:
        context pool

      • getDialogs

        Dialogs getDialogs()
        Get dialogs object.

        Dialogs object can be used by plugins to display common dialogs like information/error messages, or ask user for input, like read integer/double value or ask for confirmation.

        Returns:
        dialogs object

      • setProgramLocation

        void setProgramLocation​(int location)
        Sets program start location (usually a memory address).

        This method is usually called by a compiler when it finishes compilation process, if it's clear at which memory location the compiled program starts. The start location is then used by CPU, in a reset operation - PC (program counter, or something similar) is usually set to this location.

        Parameters:
        location - program start location (usually a memory address)

      • getProgramLocation

        int getProgramLocation()
        Gets program start location (usually a memory address).

        This method is usually called by a CPU in a reset operation - PC (program counter, or something similar) is usually set to this location.

        Returns:
        program's start address in memory