emulib.plugins.compiler

Interface Compiler

All Superinterfaces:

Plugin

All Known Implementing Classes:

AbstractCompiler

public interface Compiler
extends Plugin

This interface is the core for compiler plug-in types. These plug-ins should implement this interface once and only once.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Compiler.CompilerListener This is an interface that should be implemented by the emuStudio, and/or other plug-ins that want to process the output of the compiler.

Method Summary

Modifier and Type	Method and Description
boolean	addCompilerListener(Compiler.CompilerListener listener) Adds CompilerListener object into list of listeners.
boolean	compile(String inputFileName) Compile an input file into the output file.
boolean	compile(String inputFileName, String outputFileName) Compile an input file into the output file.
LexicalAnalyzer	getLexer(Reader in) Get a lexical analyzer of the compiler.
int	getProgramStartAddress() Gets starting address of compiled source.
SourceFileExtension[]	getSourceSuffixList() Gets the list of supported source file name suffixes.
boolean	removeCompilerListener(Compiler.CompilerListener listener) Removes CompilerListener object from the listeners list.

Methods inherited from interface emulib.plugins.Plugin

destroy, getTitle, getVersion, initialize, isShowSettingsSupported, reset, showSettings

Method Detail

addCompilerListener

boolean addCompilerListener(Compiler.CompilerListener listener)

Adds CompilerListener object into list of listeners. If some event is occurred in the compiler, listeners methods will be called.

Parameters:

listener - CompilerListener object

Returns:

true if the listener was added, false otherwise

removeCompilerListener

boolean removeCompilerListener(Compiler.CompilerListener listener)

Removes CompilerListener object from the listeners list.

Parameters:

listener - CompilerListener object

Returns:

true if the listener was removed, false otherwise

compile

boolean compile(String inputFileName,
                String outputFileName)

Compile an input file into the output file.

Parameters:

inputFileName - name of the input file (source code)

outputFileName - name of the output file (compiled code)

Returns:

true if compile was successful, false otherwise

compile

boolean compile(String inputFileName)

Compile an input file into the output file. Output file name is derived by the compiler itself. Usually, the extension of the input file is replaced by another one, denoting compiled file. It is compiler-specific.

Parameters:

inputFileName - name of the input file (source code)

Returns:

true if compile was successful, false otherwise

getLexer

LexicalAnalyzer getLexer(Reader in)

Get a lexical analyzer of the compiler. It is used by main module for syntax highlighting. In the compilation process the compiler should use own, independent lexical analyzer.

Parameters:

in - Reader object of the document - source code.

Returns:

lexical analyzer object

getProgramStartAddress

int getProgramStartAddress()

Gets starting address of compiled source. It is (or can be) called only after compilation process. It should return the first occurrence of compiled program. The word "address" can be replaced by a term "offset from 0". One step in address has size of one byte. It means that return value should not be related to operating memory units and should not deliberate techniques used in operating memory, e.g. banking.

Returns:

address of program's first occurrence

getSourceSuffixList

SourceFileExtension[] getSourceSuffixList()

Gets the list of supported source file name suffixes. The list is case insensitive. This method is called only once by emuStudio.

Returns:

list of supported source file name suffixes