gov.llnl.babel.backend.matlab

Class GenerateMatlabClient

Implemented Interfaces:
CodeGenerator, ContextAware

public class GenerateMatlabClient
extends java.lang.Object
implements CodeGenerator

This class is responsible for generating the Matlab client-side code. It will generate C extension types for classes and interfaces, and it will generate a native Matlab for enumerated types.

Constructor Summary

GenerateMatlabClient()
Create a Matlab client generator.

Method Summary

void
generateCode(Set symbols)
Generate Matlab client-side code for each SymbolID in the set argument.
Set
getLanguages()
Return the set of language names that this generator supports.
String
getName()
Return the canonical name of this generator.
String
getType()
Return the type of generator.
boolean
getUserSymbolsOnly()
Return true if and only if this code factory should only operate on symbols outside the sidl namespace (i.e., exclude symbols from the sidl runtime library).
void
setContext(Context context)
Routine to notify extensions of the context.
void
setName(String name)
Set the name of the generator.

Constructor Details

GenerateMatlabClient

public GenerateMatlabClient()
Create a Matlab client generator.

Method Details

generateCode

public void generateCode(Set symbols)
            throws CodeGenerationException
Generate Matlab client-side code for each SymbolID in the set argument. This is the initial entry point for generating the client-side code. This routine assumes that all necessary symbols are available in the symbol table. This method generates the client-side code as a set of files and directories.
Specified by:
generateCode in interface CodeGenerator
Parameters:
symbols - a set of SymbolID objects.
Throws:
CodeGenerationException - provide feedback when code generation fails for one reason or another.
See Also:
SymbolID

getLanguages

public Set getLanguages()
Return the set of language names that this generator supports. Normally, there is one one name per generator. However, the C++ generator can be referred to as cxx or c++, so it has two in its set. The names should be lower case. Some examples are "c", "ior", "c++", etc.
Specified by:
getLanguages in interface CodeGenerator
Returns:
a Set of strings. Each string is a language name that this generator supports.

getName

public String getName()
Specified by:
getName in interface CodeGenerator
Returns:
the return value should always be a string in the set returned by CodeGenerator.getLanguages(). It may not be equal to the name given in CodeGenerator.setName(String).

getType

public String getType()
Return the type of generator. Currently, there are three types of generator "stub", "skel" and "ior". "xml" might be added someday.
Specified by:
getType in interface CodeGenerator

getUserSymbolsOnly

public boolean getUserSymbolsOnly()
Return true if and only if this code factory should only operate on symbols outside the sidl namespace (i.e., exclude symbols from the sidl runtime library). This is typically true for C and Python where the stubs for the sidl runtime library are pregenerated. Generally, this should be true for anything other than a stub. Implementors do not need to worry about the special case of generating the sidl runtime library itself.
Specified by:
getUserSymbolsOnly in interface CodeGenerator

setContext

public void setContext(Context context)
Routine to notify extensions of the context.
Specified by:
setContext in interface ContextAware

setName

public void setName(String name)
            throws CodeGenerationException
Set the name of the generator. This sets the name of the generator as it appeared on the command line. This method should be called at least once before CodeGenerator.getName() is called.
Specified by:
setName in interface CodeGenerator
Parameters:
name - this should be the name that the end user designated for the generator.