Package com.jogamp.gluegen

Class JavaMethodBindingEmitter

java.lang.Object

com.jogamp.gluegen.FunctionEmitter

com.jogamp.gluegen.JavaMethodBindingEmitter

Direct Known Subclasses:

ProcAddressJavaMethodBindingEmitter

public class JavaMethodBindingEmitter
extends FunctionEmitter

An emitter that emits only the interface for a Java<->C JNI binding.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JavaMethodBindingEmitter.DefaultCommentEmitter	Class that emits a generic comment for JavaMethodBindingEmitters; the comment includes the C signature of the native method that is being bound by the emitter java method.
protected class	JavaMethodBindingEmitter.InterfaceCommentEmitter

Nested classes/interfaces inherited from class com.jogamp.gluegen.FunctionEmitter

FunctionEmitter.EmissionModifier

Field Summary

Fields

Modifier and Type	Field	Description
static FunctionEmitter.EmissionModifier	ABSTRACT
protected MethodBinding	binding
protected CommentEmitter	defaultInterfaceCommentEmitter
protected CommentEmitter	defaultJavaCommentEmitter
protected List<String>	epilogue
static FunctionEmitter.EmissionModifier	FINAL
static FunctionEmitter.EmissionModifier	NATIVE
static FunctionEmitter.EmissionModifier	PRIVATE
protected List<String>	prologue
static FunctionEmitter.EmissionModifier	PROTECTED
static FunctionEmitter.EmissionModifier	PUBLIC
static FunctionEmitter.EmissionModifier	SYNCHRONIZED
protected boolean	tagNativeBinding
protected boolean	useNIODirectOnly

Fields inherited from class com.jogamp.gluegen.FunctionEmitter

cfg, STATIC

Constructor Summary

Constructors

Constructor	Description
JavaMethodBindingEmitter(JavaMethodBindingEmitter arg)
JavaMethodBindingEmitter(MethodBinding binding, PrintWriter output, String runtimeExceptionType, String unsupportedExceptionType, boolean emitBody, boolean tagNativeBinding, boolean eraseBufferAndArrayTypes, boolean useNIOOnly, boolean useNIODirectOnly, boolean forDirectBufferImplementation, boolean forIndirectBufferAndArrayImplementation, boolean isUnimplemented, boolean isInterface, boolean isNativeMethod, boolean isPrivateNativeMethod, JavaConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
protected String[]	argumentNameArray()
protected String	byteOffsetArgName(int i)
protected static String	byteOffsetArgName(String s)
protected String	byteOffsetArrayArgName(int i)
protected int	emitArguments(PrintWriter writer)	Returns the number of arguments emitted.
protected void	emitArrayLengthAndNIOBufferChecks(MethodBinding binding, PrintWriter writer)
protected void	emitBody(PrintWriter writer)
protected void	emitCall(MethodBinding binding, PrintWriter writer)
protected int	emitCallArguments(MethodBinding binding, PrintWriter writer)
protected void	emitCallResultReturn(MethodBinding binding, PrintWriter writer)
protected void	emitCompoundArrayCopies(MethodBinding binding, PrintWriter writer)
protected void	emitName(PrintWriter writer)
protected void	emitPostCallCleanup(MethodBinding binding, PrintWriter writer)
protected void	emitPreCallSetup(MethodBinding binding, PrintWriter writer)
protected void	emitPrologueOrEpilogue(List<String> code, PrintWriter writer)
protected void	emitReturnType(PrintWriter writer)
protected void	emitReturnVariableSetupAndCall(MethodBinding binding, PrintWriter writer)
protected String	erasedTypeString(JavaType type, boolean skipBuffers)
protected String	getArgumentName(int i)
protected String	getBaseIndentString()
MethodBinding	getBinding()
protected String	getCommentEndString()
protected String	getCommentStartString()
FunctionSymbol	getCSymbol()
String	getImplName()
String	getInterfaceName()
protected String	getNativeImplMethodName()
String	getNativeName()
protected String	getReturnedArrayLengthComment()
protected String	getReturnedArrayLengthExpression()
protected String	getReturnTypeString(boolean skipArray)
String	getRuntimeExceptionType()	The type of exception (must subclass java.lang.RuntimeException) raised if runtime checks fail in the generated code.
String	getUnsupportedExceptionType()
boolean	isForDirectBufferImplementation()
boolean	isForIndirectBufferAndArrayImplementation()
boolean	isNativeMethod()
protected String	isNIOArgName(int i)
protected String	isNIOArgName(String s)
boolean	isPrivateNativeMethod()
static String	javaThisArgumentName()
protected String	offsetArgName(int i)
void	setEmitBody(boolean emitBody)	Accessor for subclasses.
void	setEpilogue(List<String> epilogue)	Sets the manually-generated epilogue code for this emitter.
void	setEraseBufferAndArrayTypes(boolean erase)	Accessor for subclasses.
void	setForDirectBufferImplementation(boolean direct)	Accessor for subclasses.
void	setForIndirectBufferAndArrayImplementation(boolean indirect)	Accessor for subclasses.
void	setPrivateNativeMethod(boolean v)	Accessor for subclasses.
void	setPrologue(List<String> prologue)	Sets the manually-generated prologue code for this emitter.
void	setReturnedArrayLengthExpression(String expr)	If the underlying function returns an array (currently only arrays of compound types are supported) as opposed to a pointer to an object, this method should be called to provide a MessageFormat string containing an expression that computes the number of elements of the returned array.
protected void	setReturnedArrayLengthExpression(String expr, boolean onlyForComments)
boolean	signatureOnly()	Indicates whether this emitter will print only a signature, or whether it will emit Java code for the body of the method as well.

Methods inherited from class com.jogamp.gluegen.FunctionEmitter

addModifier, addModifiers, clearModifiers, emit, emit, emitDocComment, emitModifiers, emitSignature, getCommentEmitter, getDefaultOutput, getModifiers, hasModifier, isInterface, removeModifier, setCommentEmitter, toString

Methods inherited from class java.lang.Object

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

Field Detail

PUBLIC

public static final FunctionEmitter.EmissionModifier PUBLIC

PROTECTED

public static final FunctionEmitter.EmissionModifier PROTECTED

PRIVATE

public static final FunctionEmitter.EmissionModifier PRIVATE

ABSTRACT

public static final FunctionEmitter.EmissionModifier ABSTRACT

FINAL

public static final FunctionEmitter.EmissionModifier FINAL

NATIVE

public static final FunctionEmitter.EmissionModifier NATIVE

SYNCHRONIZED

public static final FunctionEmitter.EmissionModifier SYNCHRONIZED

defaultJavaCommentEmitter

protected final CommentEmitter defaultJavaCommentEmitter

defaultInterfaceCommentEmitter

protected final CommentEmitter defaultInterfaceCommentEmitter

tagNativeBinding

protected final boolean tagNativeBinding

useNIODirectOnly

protected final boolean useNIODirectOnly

binding

protected final MethodBinding binding

prologue

protected List<String> prologue

epilogue

protected List<String> epilogue

Constructor Detail

JavaMethodBindingEmitter

public JavaMethodBindingEmitter(MethodBinding binding,
                                PrintWriter output,
                                String runtimeExceptionType,
                                String unsupportedExceptionType,
                                boolean emitBody,
                                boolean tagNativeBinding,
                                boolean eraseBufferAndArrayTypes,
                                boolean useNIOOnly,
                                boolean useNIODirectOnly,
                                boolean forDirectBufferImplementation,
                                boolean forIndirectBufferAndArrayImplementation,
                                boolean isUnimplemented,
                                boolean isInterface,
                                boolean isNativeMethod,
                                boolean isPrivateNativeMethod,
                                JavaConfiguration configuration)

JavaMethodBindingEmitter

public JavaMethodBindingEmitter(JavaMethodBindingEmitter arg)

Method Detail

getBinding

public final MethodBinding getBinding()

isNativeMethod

public boolean isNativeMethod()

isPrivateNativeMethod

public boolean isPrivateNativeMethod()

isForDirectBufferImplementation

public boolean isForDirectBufferImplementation()

isForIndirectBufferAndArrayImplementation

public boolean isForIndirectBufferAndArrayImplementation()

getInterfaceName

public String getInterfaceName()

Specified by:

getInterfaceName in class FunctionEmitter

getImplName

public String getImplName()

Specified by:

getImplName in class FunctionEmitter

getNativeName

public String getNativeName()

Specified by:

getNativeName in class FunctionEmitter

getCSymbol

public FunctionSymbol getCSymbol()

Specified by:

getCSymbol in class FunctionEmitter

getArgumentName

protected String getArgumentName(int i)

getRuntimeExceptionType

public String getRuntimeExceptionType()

The type of exception (must subclass java.lang.RuntimeException) raised if runtime checks fail in the generated code.

getUnsupportedExceptionType

public String getUnsupportedExceptionType()

setReturnedArrayLengthExpression

public void setReturnedArrayLengthExpression(String expr)

If the underlying function returns an array (currently only arrays of compound types are supported) as opposed to a pointer to an object, this method should be called to provide a MessageFormat string containing an expression that computes the number of elements of the returned array. The parameters to the MessageFormat expression are the names of the incoming Java arguments.

setReturnedArrayLengthExpression

protected void setReturnedArrayLengthExpression(String expr,
                                                boolean onlyForComments)

getReturnedArrayLengthExpression

protected String getReturnedArrayLengthExpression()

getReturnedArrayLengthComment

protected String getReturnedArrayLengthComment()

setPrologue

public void setPrologue(List<String> prologue)

Sets the manually-generated prologue code for this emitter.

setEpilogue

public void setEpilogue(List<String> epilogue)

Sets the manually-generated epilogue code for this emitter.

signatureOnly

public boolean signatureOnly()

Indicates whether this emitter will print only a signature, or whether it will emit Java code for the body of the method as well.

setEmitBody

public void setEmitBody(boolean emitBody)

Accessor for subclasses.

setEraseBufferAndArrayTypes

public void setEraseBufferAndArrayTypes(boolean erase)

Accessor for subclasses.

setPrivateNativeMethod

public void setPrivateNativeMethod(boolean v)

Accessor for subclasses.

setForDirectBufferImplementation

public void setForDirectBufferImplementation(boolean direct)

Accessor for subclasses.

setForIndirectBufferAndArrayImplementation

public void setForIndirectBufferAndArrayImplementation(boolean indirect)

Accessor for subclasses.

emitReturnType

protected void emitReturnType(PrintWriter writer)

Specified by:

emitReturnType in class FunctionEmitter

erasedTypeString

protected String erasedTypeString(JavaType type,
                                  boolean skipBuffers)

getReturnTypeString

protected String getReturnTypeString(boolean skipArray)

emitName

protected void emitName(PrintWriter writer)

Specified by:

emitName in class FunctionEmitter

emitArguments

protected int emitArguments(PrintWriter writer)

Description copied from class: FunctionEmitter

Returns the number of arguments emitted.

Specified by:

emitArguments in class FunctionEmitter

getNativeImplMethodName

protected String getNativeImplMethodName()

byteOffsetArgName

protected String byteOffsetArgName(int i)

byteOffsetArgName

protected static String byteOffsetArgName(String s)

isNIOArgName

protected String isNIOArgName(int i)

isNIOArgName

protected String isNIOArgName(String s)

byteOffsetArrayArgName

protected String byteOffsetArrayArgName(int i)

offsetArgName

protected String offsetArgName(int i)

emitBody

protected void emitBody(PrintWriter writer)

Specified by:

emitBody in class FunctionEmitter

emitPrologueOrEpilogue

protected void emitPrologueOrEpilogue(List<String> code,
                                      PrintWriter writer)

emitPreCallSetup

protected void emitPreCallSetup(MethodBinding binding,
                                PrintWriter writer)

emitArrayLengthAndNIOBufferChecks

protected void emitArrayLengthAndNIOBufferChecks(MethodBinding binding,
                                                 PrintWriter writer)

emitCompoundArrayCopies

protected void emitCompoundArrayCopies(MethodBinding binding,
                                       PrintWriter writer)

emitCall

protected void emitCall(MethodBinding binding,
                        PrintWriter writer)

emitReturnVariableSetupAndCall

protected void emitReturnVariableSetupAndCall(MethodBinding binding,
                                              PrintWriter writer)

emitCallArguments

protected int emitCallArguments(MethodBinding binding,
                                PrintWriter writer)

emitPostCallCleanup

protected void emitPostCallCleanup(MethodBinding binding,
                                   PrintWriter writer)

emitCallResultReturn

protected void emitCallResultReturn(MethodBinding binding,
                                    PrintWriter writer)

argumentNameArray

protected String[] argumentNameArray()

javaThisArgumentName

public static String javaThisArgumentName()

getCommentStartString

protected String getCommentStartString()

Overrides:

getCommentStartString in class FunctionEmitter

getCommentEndString

protected String getCommentEndString()

Overrides:

getCommentEndString in class FunctionEmitter

getBaseIndentString

protected String getBaseIndentString()

Overrides:

getBaseIndentString in class FunctionEmitter