Modifier and Type	Class and 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

Modifier and Type	Field and Description
public static final FunctionEmitter.EmissionModifier	ABSTRACT
protected final MethodBinding	binding
private static final String	COMPOUND_ARRAY_SUFFIX
protected final CommentEmitter	defaultInterfaceCommentEmitter
protected final CommentEmitter	defaultJavaCommentEmitter
private boolean	emitBody
protected List<String>	epilogue
private boolean	eraseBufferAndArrayTypes
public static final FunctionEmitter.EmissionModifier	FINAL
private boolean	forDirectBufferImplementation
private boolean	forIndirectBufferAndArrayImplementation
private final boolean	isNativeMethod
private boolean	isPrivateNativeMethod
private final boolean	isUnimplemented
public static final FunctionEmitter.EmissionModifier	NATIVE
public static final FunctionEmitter.EmissionModifier	PRIVATE
protected List<String>	prologue
public static final FunctionEmitter.EmissionModifier	PROTECTED
public static final FunctionEmitter.EmissionModifier	PUBLIC
private String	returnedArrayLengthExpression
private boolean	returnedArrayLengthExpressionOnlyForComments
private final String	runtimeExceptionType
public static final FunctionEmitter.EmissionModifier	SYNCHRONIZED
protected final boolean	tagNativeBinding
private final String	unsupportedExceptionType
protected final boolean	useNIODirectOnly
private final boolean	useNIOOnly

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

Method Summary

Modifier and Type	Method and Description
protected String[]	argumentNameArray()
protected String	byteOffsetArgName(final int i)
protected static String	byteOffsetArgName(final String s)
protected String	byteOffsetArrayArgName(final int i)
protected int	emitArguments(final PrintWriter writer) Implements abstract com.jogamp.gluegen.FunctionEmitter.emitArguments. Returns the number of arguments emitted.
protected void	emitArrayLengthAndNIOBufferChecks(final MethodBinding binding, final PrintWriter writer)
protected void	emitBody(final PrintWriter writer) Implements abstract com.jogamp.gluegen.FunctionEmitter.emitBody.
protected void	emitCall(final MethodBinding binding, final PrintWriter writer)
protected int	emitCallArguments(final MethodBinding binding, final PrintWriter writer)
protected void	emitCallResultReturn(final MethodBinding binding, final PrintWriter writer)
protected void	emitCompoundArrayCopies(final MethodBinding binding, final PrintWriter writer)
protected void	emitName(final PrintWriter writer) Implements abstract com.jogamp.gluegen.FunctionEmitter.emitName.
protected void	emitPostCallCleanup(final MethodBinding binding, final PrintWriter writer)
protected void	emitPreCallSetup(final MethodBinding binding, final PrintWriter writer)
protected void	emitPrologueOrEpilogue(final List<String> code, final PrintWriter writer)
protected void	emitReturnType(final PrintWriter writer) Implements abstract com.jogamp.gluegen.FunctionEmitter.emitReturnType.
protected void	emitReturnVariableSetupAndCall(final MethodBinding binding, final PrintWriter writer)
protected String	erasedTypeString(final JavaType type, final boolean skipBuffers)
protected String	getArgumentName(final int i)
protected String	getBaseIndentString() Overrides com.jogamp.gluegen.FunctionEmitter.getBaseIndentString.
public final MethodBinding	getBinding()
protected String	getCommentEndString() Overrides com.jogamp.gluegen.FunctionEmitter.getCommentEndString.
protected String	getCommentStartString() Overrides com.jogamp.gluegen.FunctionEmitter.getCommentStartString.
public FunctionSymbol	getCSymbol() Implements abstract com.jogamp.gluegen.FunctionEmitter.getCSymbol.
public String	getImplName() Implements abstract com.jogamp.gluegen.FunctionEmitter.getImplName.
public String	getInterfaceName() Implements abstract com.jogamp.gluegen.FunctionEmitter.getInterfaceName.
protected String	getNativeImplMethodName()
public String	getNativeName() Implements abstract com.jogamp.gluegen.FunctionEmitter.getNativeName.
protected String	getReturnedArrayLengthComment()
protected String	getReturnedArrayLengthExpression()
protected String	getReturnTypeString(final boolean skipArray)
public String	getRuntimeExceptionType() The type of exception (must subclass `java.lang.RuntimeException`) raised if runtime checks fail in the generated code.
public String	getUnsupportedExceptionType()
public boolean	isForDirectBufferImplementation()
public boolean	isForIndirectBufferAndArrayImplementation()
public boolean	isNativeMethod()
protected String	isNIOArgName(final int i)
protected String	isNIOArgName(final String s)
public boolean	isPrivateNativeMethod()
public static String	javaThisArgumentName()
protected String	offsetArgName(final int i)
public void	setEmitBody(final boolean emitBody) Accessor for subclasses.
public void	setEpilogue(final List<String> epilogue) Sets the manually-generated epilogue code for this emitter.
public void	setEraseBufferAndArrayTypes(final boolean erase) Accessor for subclasses.
public void	setForDirectBufferImplementation(final boolean direct) Accessor for subclasses.
public void	setForIndirectBufferAndArrayImplementation(final boolean indirect) Accessor for subclasses.
public void	setPrivateNativeMethod(final boolean v) Accessor for subclasses.
public void	setPrologue(final List<String> prologue) Sets the manually-generated prologue code for this emitter.
public void	setReturnedArrayLengthExpression(final 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(final String expr, final boolean onlyForComments)
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.

Inherited from com.jogamp.gluegen.FunctionEmitter:: addModifier addModifiers clearModifiers emit emit emitDocComment emitModifiers emitSignature getCommentEmitter getDefaultOutput getModifiers hasModifier isInterface removeModifier setCommentEmitter toString

Field Detail

ABSTRACT	back to summary
public static final FunctionEmitter.EmissionModifier ABSTRACT

binding	back to summary
protected final MethodBinding binding

COMPOUND_ARRAY_SUFFIX	back to summary
private static final String COMPOUND_ARRAY_SUFFIX

defaultInterfaceCommentEmitter	back to summary
protected final CommentEmitter defaultInterfaceCommentEmitter

defaultJavaCommentEmitter	back to summary
protected final CommentEmitter defaultJavaCommentEmitter

emitBody	back to summary
private boolean emitBody

epilogue	back to summary
protected List<String> epilogue

eraseBufferAndArrayTypes	back to summary
private boolean eraseBufferAndArrayTypes

FINAL	back to summary
public static final FunctionEmitter.EmissionModifier FINAL

forDirectBufferImplementation	back to summary
private boolean forDirectBufferImplementation

forIndirectBufferAndArrayImplementation	back to summary
private boolean forIndirectBufferAndArrayImplementation

isNativeMethod	back to summary
private final boolean isNativeMethod

isPrivateNativeMethod	back to summary
private boolean isPrivateNativeMethod

isUnimplemented	back to summary
private final boolean isUnimplemented

NATIVE	back to summary
public static final FunctionEmitter.EmissionModifier NATIVE

PRIVATE	back to summary
public static final FunctionEmitter.EmissionModifier PRIVATE

prologue	back to summary
protected List<String> prologue

PROTECTED	back to summary
public static final FunctionEmitter.EmissionModifier PROTECTED

PUBLIC	back to summary
public static final FunctionEmitter.EmissionModifier PUBLIC

returnedArrayLengthExpression	back to summary
private String returnedArrayLengthExpression

returnedArrayLengthExpressionOnlyForComments	back to summary
private boolean returnedArrayLengthExpressionOnlyForComments

runtimeExceptionType	back to summary
private final String runtimeExceptionType

SYNCHRONIZED	back to summary
public static final FunctionEmitter.EmissionModifier SYNCHRONIZED

tagNativeBinding	back to summary
protected final boolean tagNativeBinding

unsupportedExceptionType	back to summary
private final String unsupportedExceptionType

useNIODirectOnly	back to summary
protected final boolean useNIODirectOnly

useNIOOnly	back to summary
private final boolean useNIOOnly

Constructor Detail

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

JavaMethodBindingEmitter

back to summary

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

JavaMethodBindingEmitter	back to summary
public JavaMethodBindingEmitter(final JavaMethodBindingEmitter arg)

Method Detail

argumentNameArray	back to summary
protected String[] argumentNameArray()

byteOffsetArgName	back to summary
protected String byteOffsetArgName(final int i)

byteOffsetArgName	back to summary
protected static String byteOffsetArgName(final String s)

byteOffsetArrayArgName	back to summary
protected String byteOffsetArrayArgName(final int i)

emitArguments	back to summary
protected int emitArguments(final PrintWriter writer) Implements abstract com.jogamp.gluegen.FunctionEmitter.emitArguments. Doc from com.jogamp.gluegen.FunctionEmitter.emitArguments. Returns the number of arguments emitted. Annotations @Override

emitArguments

back to summary

protected int emitArguments(final PrintWriter writer)

Implements abstract com.jogamp.gluegen.FunctionEmitter.emitArguments.

Doc from com.jogamp.gluegen.FunctionEmitter.emitArguments.

Returns the number of arguments emitted.

Annotations

@Override

emitArrayLengthAndNIOBufferChecks	back to summary
protected void emitArrayLengthAndNIOBufferChecks(final MethodBinding binding, final PrintWriter writer)

emitBody	back to summary
protected void emitBody(final PrintWriter writer) Implements abstract com.jogamp.gluegen.FunctionEmitter.emitBody. Annotations @Override

emitBody

back to summary

protected void emitBody(final PrintWriter writer)

Implements abstract com.jogamp.gluegen.FunctionEmitter.emitBody.

Annotations

@Override

emitCall	back to summary
protected void emitCall(final MethodBinding binding, final PrintWriter writer)

emitCallArguments	back to summary
protected int emitCallArguments(final MethodBinding binding, final PrintWriter writer)

emitCallResultReturn	back to summary
protected void emitCallResultReturn(final MethodBinding binding, final PrintWriter writer)

emitCompoundArrayCopies	back to summary
protected void emitCompoundArrayCopies(final MethodBinding binding, final PrintWriter writer)

emitName	back to summary
protected void emitName(final PrintWriter writer) Implements abstract com.jogamp.gluegen.FunctionEmitter.emitName. Annotations @Override

emitName

back to summary

protected void emitName(final PrintWriter writer)

Implements abstract com.jogamp.gluegen.FunctionEmitter.emitName.

Annotations

@Override

emitPostCallCleanup	back to summary
protected void emitPostCallCleanup(final MethodBinding binding, final PrintWriter writer)

emitPreCallSetup	back to summary
protected void emitPreCallSetup(final MethodBinding binding, final PrintWriter writer)

emitPrologueOrEpilogue	back to summary
protected void emitPrologueOrEpilogue(final List<String> code, final PrintWriter writer)

emitReturnType	back to summary
protected void emitReturnType(final PrintWriter writer) Implements abstract com.jogamp.gluegen.FunctionEmitter.emitReturnType. Annotations @Override

emitReturnType

back to summary

protected void emitReturnType(final PrintWriter writer)

Implements abstract com.jogamp.gluegen.FunctionEmitter.emitReturnType.

Annotations

@Override

emitReturnVariableSetupAndCall	back to summary
protected void emitReturnVariableSetupAndCall(final MethodBinding binding, final PrintWriter writer)

erasedTypeString	back to summary
protected String erasedTypeString(final JavaType type, final boolean skipBuffers)

getArgumentName	back to summary
protected String getArgumentName(final int i)

getBaseIndentString

back to summary

protected String getBaseIndentString()

Overrides com.jogamp.gluegen.FunctionEmitter.getBaseIndentString.

Annotations

@Override

getBinding	back to summary
public final MethodBinding getBinding()

getCommentEndString

back to summary

protected String getCommentEndString()

Overrides com.jogamp.gluegen.FunctionEmitter.getCommentEndString.

Annotations

@Override

getCommentStartString

back to summary

protected String getCommentStartString()

Overrides com.jogamp.gluegen.FunctionEmitter.getCommentStartString.

Annotations

@Override

getCSymbol

back to summary

public FunctionSymbol getCSymbol()

Implements abstract com.jogamp.gluegen.FunctionEmitter.getCSymbol.

Annotations

@Override

getImplName

back to summary

public String getImplName()

Implements abstract com.jogamp.gluegen.FunctionEmitter.getImplName.

Annotations

@Override

getInterfaceName

back to summary

public String getInterfaceName()

Implements abstract com.jogamp.gluegen.FunctionEmitter.getInterfaceName.

Annotations

@Override

getNativeImplMethodName	back to summary
protected String getNativeImplMethodName()

getNativeName

back to summary

public String getNativeName()

Implements abstract com.jogamp.gluegen.FunctionEmitter.getNativeName.

Annotations

@Override

getReturnedArrayLengthComment	back to summary
protected String getReturnedArrayLengthComment()

getReturnedArrayLengthExpression	back to summary
protected String getReturnedArrayLengthExpression()

getReturnTypeString	back to summary
protected String getReturnTypeString(final boolean skipArray)

getRuntimeExceptionType	back to summary
public String getRuntimeExceptionType() The type of exception (must subclass `java.lang.RuntimeException`) raised if runtime checks fail in the generated code.

getUnsupportedExceptionType	back to summary
public String getUnsupportedExceptionType()

isForDirectBufferImplementation	back to summary
public boolean isForDirectBufferImplementation()

isForIndirectBufferAndArrayImplementation	back to summary
public boolean isForIndirectBufferAndArrayImplementation()

isNativeMethod	back to summary
public boolean isNativeMethod()

isNIOArgName	back to summary
protected String isNIOArgName(final int i)

isNIOArgName	back to summary
protected String isNIOArgName(final String s)

isPrivateNativeMethod	back to summary
public boolean isPrivateNativeMethod()

javaThisArgumentName	back to summary
public static String javaThisArgumentName()

offsetArgName	back to summary
protected String offsetArgName(final int i)

setEmitBody	back to summary
public void setEmitBody(final boolean emitBody) Accessor for subclasses.

setEpilogue	back to summary
public void setEpilogue(final List<String> epilogue) Sets the manually-generated epilogue code for this emitter.

setEraseBufferAndArrayTypes	back to summary
public void setEraseBufferAndArrayTypes(final boolean erase) Accessor for subclasses.

setForDirectBufferImplementation	back to summary
public void setForDirectBufferImplementation(final boolean direct) Accessor for subclasses.

setForIndirectBufferAndArrayImplementation	back to summary
public void setForIndirectBufferAndArrayImplementation(final boolean indirect) Accessor for subclasses.

setPrivateNativeMethod	back to summary
public void setPrivateNativeMethod(final boolean v) Accessor for subclasses.

setPrologue	back to summary
public void setPrologue(final List<String> prologue) Sets the manually-generated prologue code for this emitter.

setReturnedArrayLengthExpression

back to summary

public void setReturnedArrayLengthExpression(final 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	back to summary
protected void setReturnedArrayLengthExpression(final String expr, final boolean onlyForComments)

signatureOnly	back to summary
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.

com.jogamp.gluegen back to summary

protected Class JavaMethodBindingEmitter.DefaultCommentEmitter

Class Inheritance

extends Object
implements CommentEmitter

java.lang.Object
com.jogamp.gluegen.JavaMethodBindingEmitter.DefaultCommentEmitter

All Implemented Interfaces

com.jogamp.gluegen.CommentEmitter

Known Direct Subclasses

com.jogamp.gluegen.JavaMethodBindingEmitter.InterfaceCommentEmitter, com.jogamp.gluegen.procaddress.ProcAddressJavaMethodBindingEmitter.WrappedMethodCommentEmitter

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.

Constructor Summary

Access	Constructor and Description
protected	DefaultCommentEmitter()

Method Summary

Modifier and Type	Method and Description
public void	emit(final FunctionEmitter emitter, final PrintWriter writer) Implements com.jogamp.gluegen.CommentEmitter.emit. Emit the body of a comment for the specified function; do NOT emit the open (e.g., comment "/") or close (e.g., "\/") characters.
protected void	emitAliasedDocNamesComment(final AliasedSymbol sym, final PrintWriter writer)
protected StringBuilder	emitAliasedDocNamesComment(final AliasedSymbol sym, final StringBuilder sb)
protected void	emitBeginning(final FunctionEmitter emitter, final PrintWriter writer)
protected void	emitBindingCSignature(final MethodBinding binding, final PrintWriter writer)
protected void	emitEnding(final FunctionEmitter emitter, final PrintWriter writer)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DefaultCommentEmitter	back to summary
protected DefaultCommentEmitter()

Method Detail

emit

back to summary

public void emit(final FunctionEmitter emitter, final PrintWriter writer)

Implements com.jogamp.gluegen.CommentEmitter.emit.

Doc from com.jogamp.gluegen.CommentEmitter.emit.

Emit the body of a comment for the specified function; do NOT emit the open (e.g., comment "/*") or close (e.g., "*\/") characters.

Annotations

@Override

emitAliasedDocNamesComment	back to summary
protected void emitAliasedDocNamesComment(final AliasedSymbol sym, final PrintWriter writer)

emitAliasedDocNamesComment	back to summary
protected StringBuilder emitAliasedDocNamesComment(final AliasedSymbol sym, final StringBuilder sb)

emitBeginning	back to summary
protected void emitBeginning(final FunctionEmitter emitter, final PrintWriter writer)

emitBindingCSignature	back to summary
protected void emitBindingCSignature(final MethodBinding binding, final PrintWriter writer)

emitEnding	back to summary
protected void emitEnding(final FunctionEmitter emitter, final PrintWriter writer)

public Class JavaMethodBindingEmitter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JavaMethodBindingEmitter.DefaultCommentEmitter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected Class JavaMethodBindingEmitter.InterfaceCommentEmitter

Constructor Summary

Method Summary

Constructor Detail

Method Detail