gov.llnl.babel.backend.fortran

Class ImplSource

java.lang.Object

gov.llnl.babel.backend.fortran.ImplSource

public class ImplSource
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 for a sidl class. The class will retain the previous user provided implementation when overwriting a implementation file.

Constructor Summary

Constructors

Constructor and Description
ImplSource(LanguageWriterForFortran writer, CodeSplicer splicer, Context context) Generate an instance to generate a FORTRAN implementation template.

Method Summary

Modifier and Type	Method and Description
static void	addUseForReferences(java.util.Collection symbol_refs, java.util.Collection array_refs, SymbolID id, LanguageWriterForFortran d_lw, Context d_context, boolean do_types)
static void	addUseForReferences(Extendable ext, java.util.Collection methods, LanguageWriterForFortran d_lw, Context d_context, boolean do_types)
void	addUseForReferences(Method m, SymbolID id)
static void	addUseForReferences(Method m, SymbolID id, LanguageWriterForFortran d_lw, Context d_context, boolean do_types)
static java.util.Set	arrayReferences(Class cls, Context d_context)
static java.util.Set	arrayReferences(Method m)
static gov.llnl.babel.backend.fortran.F90Method	convertMethod(Method m, SymbolID id, Context context)
static java.util.Collection	extendMethods(Extendable ext, Context d_context) Add the builtin methods to the list of methods that must be implemented.
java.util.Map	findCollisions(java.util.Map methodsSeen, Symbol sym)
static java.util.Map	findCollisions(java.util.Map methodsSeen, Symbol sym, Context d_context)
void	generateCode(Class cls) Generate the implementation FORTRAN file for a sidl class.
static void	generateCode(Class cls, LanguageWriterForFortran writer, CodeSplicer splicer, Context context) Generate the implementation FORTRAN file for a sidl class.
static java.lang.String	getArgumentDeclaration(Argument a, java.lang.String indexExprPrefix, Context context) Return the argument declaration, tailored to the specific flavor of FORTRAN.
static boolean	isInt(java.lang.String s)
static java.lang.String	uniqueName(java.lang.String name, int num)
void	useStatementsForSupers(Method m, SymbolID id)
static void	useStatementsForSupers(Method m, SymbolID id, LanguageWriterForFortran writer, CodeSplicer splicer, Context context)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImplSource

public ImplSource(LanguageWriterForFortran writer,
                  CodeSplicer splicer,
                  Context context)
           throws java.security.NoSuchAlgorithmException

Generate an instance to generate a FORTRAN implementation template.

Parameters:

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

splicer - this stores the previous implementation when one exists.

Throws:

java.security.NoSuchAlgorithmException - thrown when the JVM has not SHA hash algorithm.

Method Detail

useStatementsForSupers

public static void useStatementsForSupers(Method m,
                                          SymbolID id,
                                          LanguageWriterForFortran writer,
                                          CodeSplicer splicer,
                                          Context context)
                                   throws CodeGenerationException

Throws:

CodeGenerationException

useStatementsForSupers

public void useStatementsForSupers(Method m,
                                   SymbolID id)
                            throws CodeGenerationException

Throws:

CodeGenerationException

getArgumentDeclaration

public static java.lang.String getArgumentDeclaration(Argument a,
                                                      java.lang.String indexExprPrefix,
                                                      Context context)
                                               throws CodeGenerationException

Return the argument declaration, tailored to the specific flavor of FORTRAN.

Parameters:

a - the argument

indexExprPrefix - an optional prefix for the variables used by the index expression. This is useful for struct members in F90.

Returns:

the argument declaration string

Throws:

CodeGenerationException

arrayReferences

public static java.util.Set arrayReferences(Method m)
                                     throws CodeGenerationException

Throws:

CodeGenerationException

arrayReferences

public static java.util.Set arrayReferences(Class cls,
                                            Context d_context)
                                     throws CodeGenerationException

Throws:

CodeGenerationException

uniqueName

public static java.lang.String uniqueName(java.lang.String name,
                                          int num)

convertMethod

public static gov.llnl.babel.backend.fortran.F90Method convertMethod(Method m,
                                                                     SymbolID id,
                                                                     Context context)
                                                              throws CodeGenerationException

Throws:

CodeGenerationException

findCollisions

public java.util.Map findCollisions(java.util.Map methodsSeen,
                                    Symbol sym)
                             throws CodeGenerationException

Throws:

CodeGenerationException

findCollisions

public static java.util.Map findCollisions(java.util.Map methodsSeen,
                                           Symbol sym,
                                           Context d_context)
                                    throws CodeGenerationException

Throws:

CodeGenerationException

addUseForReferences

public static void addUseForReferences(Extendable ext,
                                       java.util.Collection methods,
                                       LanguageWriterForFortran d_lw,
                                       Context d_context,
                                       boolean do_types)
                                throws CodeGenerationException

Throws:

CodeGenerationException

addUseForReferences

public void addUseForReferences(Method m,
                                SymbolID id)
                         throws CodeGenerationException

Throws:

CodeGenerationException

addUseForReferences

public static void addUseForReferences(Method m,
                                       SymbolID id,
                                       LanguageWriterForFortran d_lw,
                                       Context d_context,
                                       boolean do_types)
                                throws CodeGenerationException

Throws:

CodeGenerationException

addUseForReferences

public static void addUseForReferences(java.util.Collection symbol_refs,
                                       java.util.Collection array_refs,
                                       SymbolID id,
                                       LanguageWriterForFortran d_lw,
                                       Context d_context,
                                       boolean do_types)
                                throws CodeGenerationException

Throws:

CodeGenerationException

extendMethods

public static java.util.Collection extendMethods(Extendable ext,
                                                 Context d_context)
                                          throws CodeGenerationException

Add the builtin methods to the list of methods that must be implemented.

Parameters:

ext - the class whose implementation is being written.

Throws:

CodeGenerationException

generateCode

public void generateCode(Class cls)
                  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:

cls - 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(Class cls,
                                LanguageWriterForFortran writer,
                                CodeSplicer splicer,
                                Context context)
                         throws CodeGenerationException,
                                java.security.NoSuchAlgorithmException

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.

java.security.NoSuchAlgorithmException - A problem with the name mangler.

isInt

public static boolean isInt(java.lang.String s)