emulib.plugins

Interface Plugin

All Known Subinterfaces:

Compiler, CPU, Device, Memory

All Known Implementing Classes:

AbstractCompiler, AbstractCPU, AbstractDevice, AbstractMemory

public interface Plugin

Plug-in main interface. The interface methods are available only to emuStudio. Plug-ins communicate between each other using special entities called "contexts". CONTRACT: Each plug-in must meet several requirements: - this interface, or its derivate, must be implemented by one and only one class (so-called "main-class") - the main class has to be annotated with @PluginType annotation with required parameters - the main class has to have single constructor with two parameters. The constructor signature must be as follows: SamplePlugin(Long pluginId, ContextPool contextPool) { ... } 1. pluginId is a unique plug-in identification. Various emuLib operations (like reading plug-in settings) require pluginId as input argument. 2. contextPool represents a pool of communication entities called "contexts". Contexts represent plug-in API intended for the communication with other plug-ins. Plug-ins should initialize and register the contexts they provide into the contextPool within the plug-in constructor. Plug-ins must not try to obtain other context from the contextPool within the constructor. For this purpose there exists the initialize() method.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys all plug-in resources.
String	getTitle() Get run-time title of this plug-in.
String	getVersion() Get version of the plug-in.
void	initialize(SettingsManager settingsManager) Perform initialization of the plug-in.
boolean	isShowSettingsSupported() Check if showSettings() is supported by this plug-in.
void	reset() Perform a reset of this plugin.
void	showSettings() Show GUI of plug-in settings, if it is provided.

Method Detail

reset

void reset()

Perform a reset of this plugin. Reset process depends on the type of the plugin and it should bring it to some default initial state.

initialize

void initialize(SettingsManager settingsManager)
         throws PluginInitializationException

Perform initialization of the plug-in. Within this method, all provided contexts should be registered, or all required contexts requested from emuLib.

Parameters:

settingsManager - manager of plug-in's settings. Plug-in use it for getting/storing/removing its custom settings. These settings are saved directly into the configuration file.

Throws:

PluginInitializationException - thrown when initialization process was not successful

destroy

void destroy()

Destroys all plug-in resources. This method is called immediately after user closes the emulator. Inside the method, the plug-in should: - unregister all registered contexts for this plug-in - execute clean-up/destroy code for used resources (GUIs, timers, threads, sockets, memory, etc).

showSettings

void showSettings()

Show GUI of plug-in settings, if it is provided. Each plug-in can have a nice GUI for settings manipulation. Plug-ins should display the GUI, if they support it. In the case of memory plug-in, show GUI of a memory. Each memory plugin should have a GUI, but it is not a must.

isShowSettingsSupported

boolean isShowSettingsSupported()

Check if showSettings() is supported by this plug-in.

Returns:

true if the plug-in has a GUI for settings; false otherwise

getTitle

String getTitle()

Get run-time title of this plug-in. The title is a matter of change during runtime - for example there might be a device which might be used many times but it is called differently for each instance.

Returns:

run-time title of the plug-in

getVersion

String getVersion()

Get version of the plug-in.

Returns:

version string