gov.llnl.babel.backend.ior
Class GenerateIORClient
java.lang.Object
gov.llnl.babel.backend.ior.GenerateIORClient
- CodeGenerator, ContextAware
public class GenerateIORClient
extends java.lang.Object
Class GenerateIORClient
is the main entry point for the IOR
code generation routines. This class calls the IOR header and source
file generation routines. It is assumed that all symbols necessary
to generate IOR code are available in the symbol table, which can be
guaranteed by calling resolveAllReferences
on the symbol
table.
void | generateCode(Set symbols) - Generate IOR code for each symbol identifier 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)
|
void | setName(String name) - Set the name of the generator.
|
GenerateIORClient
public GenerateIORClient()
The constructor does nothing interesting. The entry point for
the GenerateIORClient
class is generateCode
.
generateCode
public void generateCode(Set symbols)
throws CodeGenerationException
Generate IOR code for each symbol identifier in the set argument.
This routine assumes that all necessary symbol references are available
in the symbol table.
- generateCode in interface CodeGenerator
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.
- getLanguages in interface CodeGenerator
- a Set of strings. Each string is a language name that this
generator supports.
getName
public String getName()
Return the canonical name of this generator. This exists for cases
where a backend may have more than one name.
CodeGenerator.setName(String)
should be called at least once before this method is called.
- getName in interface CodeGenerator
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.
- 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.
- getUserSymbolsOnly in interface CodeGenerator
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.
- setName in interface CodeGenerator
name
- this should be the name that the end user designated for
the generator.