gov.llnl.babel.backend.c
Class GenerateClientC

java.lang.Object
  |
  +--gov.llnl.babel.backend.c.GenerateClientC

All Implemented Interfaces:

CodeGenerator

public class GenerateClientC

extends java.lang.Object

implements CodeGenerator

Class GenerateClientC is the main entry point for the C client-side code generation routines. This class generates the header and the stub files. It is assumed that all symbols necessary to generate C code are available in the symbol table.

Constructor Summary

GenerateClientC()
The constructor does nothing interesting.

Method Summary

void	generateCode(java.util.Set symbols) Generate C client-side code for each symbol identifier in the set argument.
java.util.Set	getLanguages() Return the set of language names that this generator supports.
java.lang.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).

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateClientC

public GenerateClientC()

The constructor does nothing interesting. The entry point for the GenerateClientC class is generateCode.

Method Detail

generateCode

public void generateCode(java.util.Set symbols)
                  throws CodeGenerationException

Generate C client-side code for each symbol identifier in the set argument. This routine assumes that all necessary symbol references are available in the symbol table.

Specified by:

generateCode in interface CodeGenerator

Parameters:

symbols - a set of Symbol instances. The generator is expetected to write code for each symbol.

Throws:

CodeGenerationException - this indicates that something failed during the code generation. It could be anything from an I/O error to a illegal data type.

getType

public java.lang.String getType()

Description copied from interface: CodeGenerator

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()

Description copied from interface: CodeGenerator

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

getLanguages

public java.util.Set getLanguages()

Description copied from interface: CodeGenerator

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.