gov.llnl.babel.backend.fortran
Class GenerateClient
java.lang.Object
gov.llnl.babel.backend.fortran.GenerateClient
- CodeGenerator, ContextAware
public class GenerateClient
extends java.lang.Object
This class implements the
CodeGenerator
interface for the FORTRAN client side code generator.
This generator creates C source code to provide the glue between
FORTRAN clients and the IOR.
void | generateCode(Set symbols) - Given a set of symbol ids, this method will generate FORTRAN stubs
(written in C) for all the symbols in the set as needed.
|
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.
|
GenerateClient
public GenerateClient()
Create a new instance.
generateCode
public void generateCode(Set symbols)
throws CodeGenerationException
Given a set of symbol ids, this method will generate FORTRAN stubs
(written in C) for all the symbols in the set as needed. Some symbol
types may not require a stub file, for example packages, and these are
silently skipped.
- generateCode in interface CodeGenerator
symbols
- a set of symbol id (symbol names) for whom stubs
should be written as needed. Each object in the
set should be a 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.
- 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.