gov.llnl.babel.backend.fortran

Class 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, Context context)
Generate an instance to generate documentation for a FORTRAN client.

Method Summary

void
generateCode(Extendable ext)
Generate the implementation FORTRAN file for a sidl class.
static void
generateCode(Symbol sym, LanguageWriterForFortran writer, Context context)
Generate the implementation FORTRAN file for a sidl class.

Constructor Details

StubDoc

public StubDoc(LanguageWriterForFortran writer,
               Context context)
Generate an instance to generate documentation for a FORTRAN client.
Parameters:
writer - the output device to which the FORTRAN documentation should be written.

Method Details

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,
                                Context context)
            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.