emulib.plugins.compiler

Class AbstractCompiler

java.lang.Object

emulib.plugins.compiler.AbstractCompiler

All Implemented Interfaces:

Compiler, Plugin

public abstract class AbstractCompiler
extends Object
implements Compiler

This class implements some fundamental functionality that can be useful within the implementation of own compiler plug-ins.

Nested Class Summary

Nested classes/interfaces inherited from interface emulib.plugins.compiler.Compiler

Compiler.CompilerListener

Field Summary

Fields

Modifier and Type	Field and Description
protected long	pluginID Identification number of this plug-in assigned by emuStudio
protected int	programStart Program start address (memory location)

Constructor Summary

Constructors

Constructor and Description
AbstractCompiler(Long pluginID) Public constructor initializes compilerListeners list and event object for event passing.

Method Summary

Modifier and Type	Method and Description
boolean	addCompilerListener(Compiler.CompilerListener listener) Adds a listener onto compilerListeners list
int	getProgramStartAddress() Returns program start address (memory location) after the compilation process.
String	getTitle() Get run-time title of this plug-in.
void	initialize(SettingsManager settings) This method semi-initializes the simple compiler.
protected void	notifyCompileFinish(int errorCode) This method notifies all compilerListeners that the compiler finished the compile process right now.
protected void	notifyCompileStart() This method notifies all compilerListeners that the compiler is starting the compile process.
void	notifyError(String mes) Notifies the error message.
void	notifyInfo(String mes) Notifies information message
void	notifyOnMessage(Message message) This method notifies all compilerListeners that the compiler wants to print something out (a message).
void	notifyWarning(String mes) Fires warning message
boolean	removeCompilerListener(Compiler.CompilerListener listener) Removes the listener from compilerListeners list
void	reset() Does nothing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface emulib.plugins.compiler.Compiler

compile, compile, getLexer, getSourceSuffixList

Methods inherited from interface emulib.plugins.Plugin

destroy, getVersion, isShowSettingsSupported, showSettings

Field Detail

programStart

protected int programStart

Program start address (memory location)

pluginID

protected final long pluginID

Identification number of this plug-in assigned by emuStudio

Constructor Detail

AbstractCompiler

public AbstractCompiler(Long pluginID)

Public constructor initializes compilerListeners list and event object for event passing.

Parameters:

pluginID - ID of the plug-in assigned by emuStudio

Method Detail

initialize

public void initialize(SettingsManager settings)
                throws PluginInitializationException

This method semi-initializes the simple compiler. It only set-up data members - pluginID and SettingsManager object. It should be overridden.

Specified by:

initialize in interface Plugin

Parameters:

settings - settings manipulation object

Throws:

PluginInitializationException - never in the default implementation

getTitle

public String getTitle()

Description copied from interface: Plugin

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.

Specified by:

getTitle in interface Plugin

Returns:

run-time title of the plug-in

getProgramStartAddress

public int getProgramStartAddress()

Returns program start address (memory location) after the compilation process. If the compile process was not ran, it will return 0.

Specified by:

getProgramStartAddress in interface Compiler

Returns:

program start address (memory location)

addCompilerListener

public boolean addCompilerListener(Compiler.CompilerListener listener)

Adds a listener onto compilerListeners list

Specified by:

addCompilerListener in interface Compiler

Parameters:

listener - listener object

Returns:

true if the listener was added, false otherwise

removeCompilerListener

public boolean removeCompilerListener(Compiler.CompilerListener listener)

Removes the listener from compilerListeners list

Specified by:

removeCompilerListener in interface Compiler

Parameters:

listener - listener object

Returns:

true if the listener was removed, false otherwise

notifyCompileStart

protected void notifyCompileStart()

This method notifies all compilerListeners that the compiler is starting the compile process. This method should be called whenever the compiler begins to run.

notifyCompileFinish

protected void notifyCompileFinish(int errorCode)

This method notifies all compilerListeners that the compiler finished the compile process right now. This method should be called whenever the compiler ends the execution.

Parameters:

errorCode - compiler-specific error code

notifyOnMessage

public void notifyOnMessage(Message message)

This method notifies all compilerListeners that the compiler wants to print something out (a message). This method should be called when the compiler wants to notify the user about some warning or error during compilation; or wants to inform the user of something else (e.g. copyright information).

Parameters:

message - The message

notifyError

public void notifyError(String mes)

Notifies the error message.

Parameters:

mes - text of the message

notifyInfo

public void notifyInfo(String mes)

Notifies information message

Parameters:

mes - text of the message

notifyWarning

public void notifyWarning(String mes)

Fires warning message

Parameters:

mes - text of the message

reset

public void reset()

Does nothing.

Specified by:

reset in interface Plugin