gov.llnl.babel.backend.ucxx
Class CxxStubSource

java.lang.Object
  extended by gov.llnl.babel.backend.ucxx.CxxStubSource

public class CxxStubSource
extends java.lang.Object

Create and write a header for a Cxx C extension class to wrap a BABEL extendable in a Cxx object. The header has to expose a function to create a wrapped IOR, a function to check if a PyObject is an instance of this extension type, and an import macro.


Constructor Summary
CxxStubSource(Extendable ext, Context context)
          Create an object capable of generating the header file for a BABEL extendable.
CxxStubSource(Extendable ext, LanguageWriterForCxx writer, Context context)
          Create an object capable of generating the header file for a BABEL extendable.
 
Method Summary
 void generateCode()
          Generate the header file for the extendable with which this object was created.
static void generateSupers(Class cls, LanguageWriterForCxx writer, Context context)
          This is a convenience utility function specifically for the generation of super "Stub" functions in the Impl files.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CxxStubSource

public CxxStubSource(Extendable ext,
                     Context context)
Create an object capable of generating the header file for a BABEL extendable.

Parameters:
ext - an interface or class symbol that needs a header file for a Cxx C extension class.

CxxStubSource

public CxxStubSource(Extendable ext,
                     LanguageWriterForCxx writer,
                     Context context)
Create an object capable of generating the header file for a BABEL extendable.

Parameters:
ext - an interface or class symbol that needs a header file for a Cxx C extension class.
Method Detail

generateSupers

public static void generateSupers(Class cls,
                                  LanguageWriterForCxx writer,
                                  Context context)
                           throws CodeGenerationException
This is a convenience utility function specifically for the generation of super "Stub" functions in the Impl files. The output stream is not closed on exit. A code generation exception is thrown if an error is detected.

Parameters:
cls - The class in which these supers are to be generated
writer - the output writer to which the stub source will be written. This will not be closed.
Throws:
CodeGenerationException - this is a catch all exception. It can be caused by I/O trouble or violations of the data type invariants.

generateCode

public void generateCode()
                  throws CodeGenerationException
Generate the header file for the extendable with which this object was created.

Throws:
CodeGenerationException - this is a catch all exception for problems during the code generation phase.