Package com.jogamp.gluegen

Class CCodeUnit

java.lang.Object

com.jogamp.gluegen.CodeUnit

com.jogamp.gluegen.CCodeUnit

public class CCodeUnit
extends CodeUnit

C code unit (a generated C source file), covering multiple FunctionEmitter allowing to unify output, decoration and dynamic helper code injection per unit.

Field Summary

Fields

Modifier and Type	Field	Description
String	cUnitName	base c-unit name with suffix.
static String	NewDirectByteBufferCopyUnitCode

Fields inherited from class com.jogamp.gluegen.CodeUnit

filename, output

Constructor Summary

Constructors

Constructor	Description
CCodeUnit(String filename, String cUnitName, Object generator)

Method Summary

Modifier and Type	Method	Description
void	emitHeader(String packageName, String className, List<String> customCode)
void	emitJNIEnvDecl()	Emits getJNIEnvDecl().
void	emitJNIOnLoadJNIEnvCode(String libraryBasename)	Emits getJNIOnLoadJNIEnvCode(String).
static String	getJNIEnvDecl()	Returns native JNI declarations for `JVMUtil_GetJavaVM()`, `JVMUtil_GetJNIEnv(..)` and `JVMUtil_ReleaseJNIEnv(..)`.
static String	getJNIOnLoadJNIEnvCode(String libraryBasename)	Returns native JNI code `JNI_OnLoad(..)` used for dynamic libraries, `JNI_OnLoad_{libraryBasename}(..)` used for static libraries, `JVMUtil_GetJNIEnv(..)` etc.
String	toString()

Methods inherited from class com.jogamp.gluegen.CodeUnit

addTailCode, close, emit, emitf, emitln, emitln, emitTailCode

Methods inherited from class java.lang.Object

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

Field Detail

cUnitName

public final String cUnitName

base c-unit name with suffix.

NewDirectByteBufferCopyUnitCode

public static final String NewDirectByteBufferCopyUnitCode

See Also:

Constant Field Values

Constructor Detail

CCodeUnit

public CCodeUnit(String filename,
                 String cUnitName,
                 Object generator)
          throws IOException

Parameters:

filename - the class's full filename to open w/ write access

cUnitName - the base c-unit name, i.e. c-file basename with suffix

generator - informal optional object that is creating this unit, used to be mentioned in a warning message if not null.

Throws:

IOException

Method Detail

emitHeader

public void emitHeader(String packageName,
                       String className,
                       List<String> customCode)

emitJNIEnvDecl

public void emitJNIEnvDecl()

Emits getJNIEnvDecl().

emitJNIOnLoadJNIEnvCode

public void emitJNIOnLoadJNIEnvCode(String libraryBasename)

Emits getJNIOnLoadJNIEnvCode(String).

toString

public String toString()

Overrides:

toString in class CodeUnit

getJNIEnvDecl

public static final String getJNIEnvDecl()

Returns native JNI declarations for `JVMUtil_GetJavaVM()`, `JVMUtil_GetJNIEnv(..)` and `JVMUtil_ReleaseJNIEnv(..)`.

See getJNIOnLoadJNIEnvCode(String) for details.

Returns:

the code

See Also:

getJNIOnLoadJNIEnvCode(String)

getJNIOnLoadJNIEnvCode

public static final String getJNIOnLoadJNIEnvCode(String libraryBasename)

Returns native JNI code `JNI_OnLoad(..)` used for dynamic libraries, `JNI_OnLoad_{libraryBasename}(..)` used for static libraries, `JVMUtil_GetJNIEnv(..)` etc.

The `JNI_OnLoad*(..)` methods set a `static JavaVM* {libraryBasename}_jvmHandle`, which in turn is utilized by `JVMUtil_GetJNIEnv(..)` to attach a new thread to the `JavaVM*` generating a new `JNIEnv*`- or just to retrieve the thread's `JNIEnv*`, if already attached to the `JavaVM*`.

Parameters:

libraryBasename - library basename to generate the `JNI_OnLoad_{libraryBasename}(..)` variant for statically linked libraries.

Returns:

the code

See Also:

#getJNIOnLoadJNIEnvDecl(String)