gov.llnl.babel.backend.fortran
Class StubDoc

java.lang.Object
  |
  +--gov.llnl.babel.backend.fortran.StubDoc

public class StubDoc

extends java.lang.Object

This class provides the ability to write a FORTRAN file with a subroutine template for each method the end user has to implement to implement a SIDL class. The class will retain the previous user provided implmentation when overwriting a implementation file.

Constructor Summary

StubDoc(LanguageWriterForFortran writer)
Generate an instance to generate documentation for a FORTRAN client.

Method Summary

static Method	createCast(SymbolID id)
static Method	createCastTwo(SymbolID id)
void	generateCode(Extendable ext) Generate the implementation FORTRAN file for a SIDL class.
static void	generateCode(Symbol sym, LanguageWriterForFortran writer) Generate the implementation FORTRAN file for a SIDL class.

Methods inherited from class java.lang.Object

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

Constructor Detail

StubDoc

public StubDoc(LanguageWriterForFortran writer)

Generate an instance to generate documentation for a FORTRAN client.

Parameters:

writer - the output device to which the FORTRAN documentation should be written.

Method Detail

createCast

public static Method createCast(SymbolID id)

createCastTwo

public static Method createCastTwo(SymbolID id)

generateCode

public void generateCode(Extendable ext)
                  throws CodeGenerationException

Generate the implementation FORTRAN file for a SIDL class. The implementation file contains all the subroutines that need to be implemented for the class, and when replacing an implementation file, the previous implementation is retained.

Parameters:

ext - the SIDL class whose implementation is to be written.

Throws:

CodeGenerationException - a catch all exception to indicate problems in the code generation phase.

generateCode

public static void generateCode(Symbol sym,
                                LanguageWriterForFortran writer)
                         throws CodeGenerationException

Generate the implementation FORTRAN file for a SIDL class. The implementation file contains all the subroutines that need to be implemented for the class, and when replacing an implementation file, the previous implementation is retained.

Throws:

CodeGenerationException - a catch all exception to indicate problems in the code generation phase.