GlueGen Runtime 2.3.2 · com.jogamp.gluegen.MethodBinding

Modifier and Type	Field and Description
private boolean	argumentsUseNIO
private boolean	computedSignatureProperties
private final Type	containingCType
private final JavaType	containingType
private final String	delegationImplName
private List<JavaType>	javaArgumentTypes
private JavaType	javaReturnType
private String	nativeName
private boolean	signatureCanUseIndirectNIO
private boolean	signatureRequiresStaticInitialization
private boolean	signatureUsesArraysOfCompoundTypeWrappers
private boolean	signatureUsesCArrays
private boolean	signatureUsesCompoundTypeWrappers
private boolean	signatureUsesCPrimitivePointers
private boolean	signatureUsesCVoidPointers
private boolean	signatureUsesJavaPrimitiveArrays
private boolean	signatureUsesNIO
private final FunctionSymbol	sym
private int	thisPointerIndex

Access	Constructor and Description
public	MethodBinding(final MethodBinding bindingToCopy) Constructs a new MethodBinding that is an exact clone of the argument, including the java return type and java argument types.
public	MethodBinding(final FunctionSymbol sym, final String delegationImplName, final JavaType javaReturnType, final List<JavaType> javaArgumentTypes, final JavaType containingType, final Type containingCType) Constructor for calling a C function or a function pointer contained in a struct.

Method Summary

Modifier and Type	Method and Description
public void	addJavaArgumentType(final JavaType type)
public boolean	argumentsUseNIO() Returns true if any of the outgoing arguments in the method's signature require conversion or checking due to the use of New I/O.
public void	clearThisPointer() Clears any record of a this pointer for this MethodBinding.
protected void	computeSignatureProperties() Computes summary information about the method's C and Java signatures.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
protected String	erasedTypeDescriptor(final JavaType type, final boolean eraseBufferAndArrayTypes, final boolean skipBuffers)
public void	findThisPointer() Find the leftmost argument matching the type of the containing type (for function pointer MethodBindings) and record that as a "this" pointer, meaning that it does not need to be explicitly passed at the Java level.
public String	getArgumentName(final int i) Returns either the argument name specified by the underlying FunctionSymbol or a fabricated argument name based on the position.
public Type	getCArgumentType(final int i)
public Type	getContainingCType() Retrieves the containing C type of this MethodBinding if it is for a function pointer contained in a struct.
public JavaType	getContainingType() Retrieves the containing type of this MethodBinding if it is for a function pointer contained in a struct.
public Type	getCReturnType()
public FunctionSymbol	getCSymbol() Returns the `FunctionSymbol`.
public String	getDelegationImplName() The `implementation delegation` name, or `null` for no delegation.
public String	getDescriptor(final boolean forImplementingMethodCall, final boolean eraseBufferAndArrayTypes) Returns a String containing the descriptor (signature in internal format) of this MethodBinding as it will be emitted.
public String	getImplName() Returns the `FunctionSymbol`'s name for the implementation, which is the current `aliased` API name per default, or the `delegation` name.
public String	getInterfaceName() Returns the `FunctionSymbol`'s current `aliased` API name for the interface.
public JavaType	getJavaArgumentType(final int i)
public JavaType	getJavaReturnType()
public String	getName() Returns the `FunctionSymbol`'s current `aliased` API name.
public String	getNativeName() Returns the `FunctionSymbol`'s name for the native function which is the `original` C API name per default, but may be overridden via `setNativeName(String)`.
public int	getNumArguments()
public boolean	hasContainingType() Indicates whether this MethodBinding is for a function pointer contained in a struct, or to access array- or pointer-data from a struct.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isArgumentThisPointer(final int i) Indicates whether the ith argument to this MethodBinding is actually a "this" pointer.
public boolean	needsNIOWrappingOrUnwrapping() Returns true if the function needs NIO-related wrapping/unwrapping or conversion of various arguments.
public MethodBinding	replaceJavaArgumentType(final int argumentNumber, final JavaType newArgType) Creates a new MethodBinding replacing the specified Java argument type with a new argument type.
public void	setJavaReturnType(final JavaType type)
public void	setNativeName(final String s)
public boolean	signatureCanUseIndirectNIO() Returns true if it is possible for any of the outgoing arguments to be indirect NIO buffers.
public boolean	signatureRequiresStaticInitialization() Returns true if the wrapper implementation requires static native code to be initialized, see `JavaConfiguration#forceStaticInitCode(String)`.
public boolean	signatureUsesArraysOfCompoundTypeWrappers() Returns true if the return type or any of the outgoing arguments in the method's signature use arrays of "compound type wrappers", or NIO-based wrappers for C data structures.
public boolean	signatureUsesCArrays() Returns true if the return type or any of the outgoing arguments in the method's signature represent C arrays.
public boolean	signatureUsesCompoundTypeWrappers() Returns true if the return type or any of the outgoing arguments in the method's signature use "compound type wrappers", or NIO-based wrappers for C data structures.
public boolean	signatureUsesCPrimitivePointers() Returns true if the return type or any of the outgoing arguments in the method's signature represent C primitive pointers.
public boolean	signatureUsesCVoidPointers() Returns true if the return type or any of the outgoing arguments in the method's signature represent C void* pointers.
public boolean	signatureUsesJavaPrimitiveArrays() Returns true if the return type or any of the outgoing arguments in the method's signature represent Java primitive arrays.
public boolean	signatureUsesNIO() Returns true if the return type or any of the outgoing arguments in the method's signature require conversion or checking due to the use of New I/O.
public String	toString() Overrides java.lang.Object.toString. Returns the signature of this binding.

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

argumentsUseNIO	back to summary
private boolean argumentsUseNIO

computedSignatureProperties	back to summary
private boolean computedSignatureProperties

containingCType	back to summary
private final Type containingCType

containingType	back to summary
private final JavaType containingType

delegationImplName	back to summary
private final String delegationImplName

javaArgumentTypes	back to summary
private List<JavaType> javaArgumentTypes

javaReturnType	back to summary
private JavaType javaReturnType

nativeName	back to summary
private String nativeName

signatureCanUseIndirectNIO	back to summary
private boolean signatureCanUseIndirectNIO

signatureRequiresStaticInitialization	back to summary
private boolean signatureRequiresStaticInitialization

signatureUsesArraysOfCompoundTypeWrappers	back to summary
private boolean signatureUsesArraysOfCompoundTypeWrappers

signatureUsesCArrays	back to summary
private boolean signatureUsesCArrays

signatureUsesCompoundTypeWrappers	back to summary
private boolean signatureUsesCompoundTypeWrappers

signatureUsesCPrimitivePointers	back to summary
private boolean signatureUsesCPrimitivePointers

signatureUsesCVoidPointers	back to summary
private boolean signatureUsesCVoidPointers

signatureUsesJavaPrimitiveArrays	back to summary
private boolean signatureUsesJavaPrimitiveArrays

signatureUsesNIO	back to summary
private boolean signatureUsesNIO

sym	back to summary
private final FunctionSymbol sym

thisPointerIndex	back to summary
private int thisPointerIndex

MethodBinding	back to summary
public MethodBinding(final MethodBinding bindingToCopy) Constructs a new MethodBinding that is an exact clone of the argument, including the java return type and java argument types. It's safe to modify this binding after construction.

MethodBinding	back to summary
public MethodBinding(final FunctionSymbol sym, final String delegationImplName, final JavaType javaReturnType, final List<JavaType> javaArgumentTypes, final JavaType containingType, final Type containingCType) Constructor for calling a C function or a function pointer contained in a struct. In case of the latter, a struct function pointer, the arguments `containingType` and `containingCType` must not be `null`!

Method Detail

addJavaArgumentType	back to summary
public void addJavaArgumentType(final JavaType type)

argumentsUseNIO	back to summary
public boolean argumentsUseNIO() Returns true if any of the outgoing arguments in the method's signature require conversion or checking due to the use of New I/O.

clearThisPointer	back to summary
public void clearThisPointer() Clears any record of a this pointer for this MethodBinding.

computeSignatureProperties	back to summary
protected void computeSignatureProperties() Computes summary information about the method's C and Java signatures.

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

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

findThisPointer	back to summary
public void findThisPointer() Find the leftmost argument matching the type of the containing type (for function pointer MethodBindings) and record that as a "this" pointer, meaning that it does not need to be explicitly passed at the Java level.

getArgumentName	back to summary
public String getArgumentName(final int i) Returns either the argument name specified by the underlying FunctionSymbol or a fabricated argument name based on the position. Note that it is currently not guaranteed that there are no namespace clashes with these fabricated argument names.

getCArgumentType	back to summary
public Type getCArgumentType(final int i)

getContainingCType	back to summary
public Type getContainingCType() Retrieves the containing C type of this MethodBinding if it is for a function pointer contained in a struct.

getContainingType	back to summary
public JavaType getContainingType() Retrieves the containing type of this MethodBinding if it is for a function pointer contained in a struct.

getCReturnType	back to summary
public Type getCReturnType()

getCSymbol	back to summary
public FunctionSymbol getCSymbol() Returns the `FunctionSymbol`.

getDelegationImplName back to summary

getDelegationImplName	back to summary
public String getDelegationImplName() The `implementation delegation` name, or `null` for no delegation. See Also `getImplName()`

public String getDelegationImplName()

The implementation delegation name, or null for no delegation.

See Also: getImplName()

getDescriptor	back to summary
public String getDescriptor(final boolean forImplementingMethodCall, final boolean eraseBufferAndArrayTypes) Returns a String containing the descriptor (signature in internal format) of this MethodBinding as it will be emitted. This is used to disambiguate between overloadings when manually specifying prologue and epilogue code, for example.

getImplName back to summary

getImplName	back to summary
public String getImplName() Returns the `FunctionSymbol`'s name for the implementation, which is the current `aliased` API name per default, or the `delegation` name. See Also `getDelegationImplName()`

public String getImplName()

Returns the FunctionSymbol's name for the implementation, which is the current aliased API name per default, or the delegation name.

See Also: getDelegationImplName()

getInterfaceName	back to summary
public String getInterfaceName() Returns the `FunctionSymbol`'s current `aliased` API name for the interface.

getJavaArgumentType	back to summary
public JavaType getJavaArgumentType(final int i)

getJavaReturnType	back to summary
public JavaType getJavaReturnType()

getName	back to summary
public String getName() Returns the `FunctionSymbol`'s current `aliased` API name.

getNativeName	back to summary
public String getNativeName() Returns the `FunctionSymbol`'s name for the native function which is the `original` C API name per default, but may be overridden via `setNativeName(String)`.

getNumArguments	back to summary
public int getNumArguments()

hasContainingType back to summary

hasContainingType	back to summary
public boolean hasContainingType() Indicates whether this MethodBinding is for a function pointer contained in a struct, or to access array- or pointer-data from a struct. The native calling convention, i.e. via a 'this' function pointer or by a static native function must be decided in the `JavaEmitter` handling structs and passed to the `CMethodBindingEmitter#setIsCStructFunctionPointer(boolean)`.

public boolean hasContainingType()

Indicates whether this MethodBinding is for a function pointer contained in a struct, or to access array- or pointer-data from a struct.

The native calling convention, i.e. via a 'this' function pointer or by a static native function must be decided in the JavaEmitter handling structs and passed to the CMethodBindingEmitter#setIsCStructFunctionPointer(boolean).

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isArgumentThisPointer	back to summary
public boolean isArgumentThisPointer(final int i) Indicates whether the ith argument to this MethodBinding is actually a "this" pointer.

needsNIOWrappingOrUnwrapping	back to summary
public boolean needsNIOWrappingOrUnwrapping() Returns true if the function needs NIO-related wrapping/unwrapping or conversion of various arguments. Currently this returns the logical OR of signatureUsesNIO(), signatureUsesCompoundTypeWrappers() and signatureUsesArraysOfCompoundTypeWrappers().

replaceJavaArgumentType	back to summary
public MethodBinding replaceJavaArgumentType(final int argumentNumber, final JavaType newArgType) Creates a new MethodBinding replacing the specified Java argument type with a new argument type. If argumentNumber is less than 0 then replaces the return type.

setJavaReturnType	back to summary
public void setJavaReturnType(final JavaType type)

setNativeName	back to summary
public void setNativeName(final String s)

signatureCanUseIndirectNIO	back to summary
public boolean signatureCanUseIndirectNIO() Returns true if it is possible for any of the outgoing arguments to be indirect NIO buffers.

signatureRequiresStaticInitialization back to summary

public boolean signatureRequiresStaticInitialization()

Returns true if the wrapper implementation requires static native code to be initialized, see JavaConfiguration#forceStaticInitCode(String).

Currently triggered by:

Return type is a "compound type" and not a pointer

signatureUsesArraysOfCompoundTypeWrappers	back to summary
public boolean signatureUsesArraysOfCompoundTypeWrappers() Returns true if the return type or any of the outgoing arguments in the method's signature use arrays of "compound type wrappers", or NIO-based wrappers for C data structures.

signatureUsesCArrays	back to summary
public boolean signatureUsesCArrays() Returns true if the return type or any of the outgoing arguments in the method's signature represent C arrays.

signatureUsesCompoundTypeWrappers	back to summary
public boolean signatureUsesCompoundTypeWrappers() Returns true if the return type or any of the outgoing arguments in the method's signature use "compound type wrappers", or NIO-based wrappers for C data structures.

signatureUsesCPrimitivePointers	back to summary
public boolean signatureUsesCPrimitivePointers() Returns true if the return type or any of the outgoing arguments in the method's signature represent C primitive pointers.

signatureUsesCVoidPointers	back to summary
public boolean signatureUsesCVoidPointers() Returns true if the return type or any of the outgoing arguments in the method's signature represent C void* pointers.

signatureUsesJavaPrimitiveArrays	back to summary
public boolean signatureUsesJavaPrimitiveArrays() Returns true if the return type or any of the outgoing arguments in the method's signature represent Java primitive arrays.

signatureUsesNIO	back to summary
public boolean signatureUsesNIO() Returns true if the return type or any of the outgoing arguments in the method's signature require conversion or checking due to the use of New I/O.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the signature of this binding.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

public Class MethodBinding

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail