Class DynCall
- java.lang.Object
-
- org.lwjgl.system.dyncall.DynCall
-
public class DynCall extends java.lang.Object
Native bindings to \"dyncall.h\".The dyncall library encapsulates architecture-, OS- and compiler-specific function call semantics in a virtual "bind argument parameters from left to right and then call" interface allowing programmers to call C functions in a completely dynamic manner.
In other words, instead of calling a function directly, the dyncall library provides a mechanism to push the function parameters manually and to issue the call afterwards.
Since the idea behind this concept is similar to call dispatching mechanisms of virtual machines, the object that can be dynamically loaded with arguments, and then used to actually invoke the call, is called
CallVM
. It is possible to change the calling convention used by theCallVM
at run-time. Due to the fact that nearly every platform comes with one or more distinct calling conventions, the dyncall library project intends to be a portable and open-source approach to the variety of compiler-specific binary interfaces, platform specific subtleties, and so on...
-
-
Field Summary
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
dcArgBool(long vm, boolean value)
Binds abool
argument.static void
dcArgChar(long vm, byte value)
Binds achar
argument.static void
dcArgDouble(long vm, double value)
Binds adouble
argument.static void
dcArgFloat(long vm, float value)
Binds afloat
argument.static void
dcArgInt(long vm, int value)
Binds anint
argument.static void
dcArgLong(long vm, long value)
Binds along
argument.static void
dcArgLongLong(long vm, long value)
Binds along long
argument.static void
dcArgPointer(long vm, long value)
Binds a pointer argument.static void
dcArgShort(long vm, short value)
Binds ashort
argument.static void
dcArgStruct(long vm, long s, long value)
Binds a struct argument.static boolean
dcCallBool(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static byte
dcCallChar(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static double
dcCallDouble(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static float
dcCallFloat(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static int
dcCallInt(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static long
dcCallLong(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static long
dcCallLongLong(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static long
dcCallPointer(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static short
dcCallShort(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static void
dcCallStruct(long vm, long funcptr, long s, long returnValue)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static void
dcCallVoid(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.static void
dcCloseStruct(long s)
Completes the struct definition.static long
dcDefineStruct(java.lang.CharSequence signature)
Creates a new struct type using a signature string.static long
dcDefineStruct(java.nio.ByteBuffer signature)
Creates a new struct type using a signature string.static void
dcFree(long vm)
Frees aCallVM
object.static void
dcFreeStruct(long s)
Frees the specified struct object.static int
dcGetError(long vm)
Returns the most recent error state code.static void
dcMode(long vm, int mode)
Sets the calling convention to use.static long
dcNewCallVM(long size)
Creates a newCallVM
object.static long
dcNewStruct(long fieldCount, int alignment)
Creates a new struct type.static void
dcReset(long vm)
Resets the internal stack of arguments and prepares it for a new call.static long
dcStructAlignment(long s)
Returns the alignment, in bytes, of the specified struct.static void
dcStructField(long s, int type, int alignment, long arrayLength)
Adds a field to the specified struct.static long
dcStructSize(long s)
Returns the size, in bytes, of the specified struct.static void
dcSubStruct(long s, long fieldCount, int alignment, long arrayLength)
Adds a nested struct to the specified structstatic void
ndcArgBool(long vm, int value)
Unsafe version of:ArgBool
static void
ndcArgChar(long vm, byte value)
Unsafe version of:ArgChar
static void
ndcArgDouble(long vm, double value)
Unsafe version of:ArgDouble
static void
ndcArgFloat(long vm, float value)
Unsafe version of:ArgFloat
static void
ndcArgInt(long vm, int value)
Unsafe version of:ArgInt
static void
ndcArgLong(long vm, long value)
Unsafe version of:ArgLong
static void
ndcArgLongLong(long vm, long value)
Unsafe version of:ArgLongLong
static void
ndcArgPointer(long vm, long value)
Unsafe version of:ArgPointer
static void
ndcArgShort(long vm, short value)
Unsafe version of:ArgShort
static void
ndcArgStruct(long vm, long s, long value)
Unsafe version of:ArgStruct
static int
ndcCallBool(long vm, long funcptr)
Unsafe version of:CallBool
static byte
ndcCallChar(long vm, long funcptr)
Unsafe version of:CallChar
static double
ndcCallDouble(long vm, long funcptr)
Unsafe version of:CallDouble
static float
ndcCallFloat(long vm, long funcptr)
Unsafe version of:CallFloat
static int
ndcCallInt(long vm, long funcptr)
Unsafe version of:CallInt
static long
ndcCallLong(long vm, long funcptr)
Unsafe version of:CallLong
static long
ndcCallLongLong(long vm, long funcptr)
Unsafe version of:CallLongLong
static long
ndcCallPointer(long vm, long funcptr)
Unsafe version of:CallPointer
static short
ndcCallShort(long vm, long funcptr)
Unsafe version of:CallShort
static void
ndcCallStruct(long vm, long funcptr, long s, long returnValue)
Unsafe version of:CallStruct
static void
ndcCallVoid(long vm, long funcptr)
Unsafe version of:CallVoid
static void
ndcCloseStruct(long s)
Unsafe version of:CloseStruct
static long
ndcDefineStruct(long signature)
Unsafe version of:DefineStruct
static void
ndcFree(long vm)
Unsafe version of:Free
static void
ndcFreeStruct(long s)
Unsafe version of:FreeStruct
static int
ndcGetError(long vm)
Unsafe version of:GetError
static void
ndcMode(long vm, int mode)
Unsafe version of:Mode
static void
ndcReset(long vm)
Unsafe version of:Reset
static long
ndcStructAlignment(long s)
Unsafe version of:StructAlignment
static void
ndcStructField(long s, int type, int alignment, long arrayLength)
Unsafe version of:StructField
static long
ndcStructSize(long s)
Unsafe version of:StructSize
static void
ndcSubStruct(long s, long fieldCount, int alignment, long arrayLength)
Unsafe version of:SubStruct
-
-
-
Field Detail
-
DC_CALL_C_DEFAULT, DC_CALL_C_ELLIPSIS, DC_CALL_C_ELLIPSIS_VARARGS, DC_CALL_C_X86_CDECL, DC_CALL_C_X86_WIN32_STD, DC_CALL_C_X86_WIN32_FAST_MS, DC_CALL_C_X86_WIN32_FAST_GNU, DC_CALL_C_X86_WIN32_THIS_MS, DC_CALL_C_X86_WIN32_THIS_GNU, DC_CALL_C_X64_WIN64, DC_CALL_C_X64_SYSV, DC_CALL_C_PPC32_DARWIN, DC_CALL_C_PPC32_OSX, DC_CALL_C_ARM_ARM_EABI, DC_CALL_C_ARM_THUMB_EABI, DC_CALL_C_ARM_ARMHF, DC_CALL_C_MIPS32_EABI, DC_CALL_C_PPC32_SYSV, DC_CALL_C_PPC32_LINUX, DC_CALL_C_ARM_ARM, DC_CALL_C_ARM_THUMB, DC_CALL_C_MIPS32_O32, DC_CALL_C_MIPS64_N32, DC_CALL_C_MIPS64_N64, DC_CALL_C_X86_PLAN9, DC_CALL_C_SPARC32, DC_CALL_C_SPARC64, DC_CALL_C_ARM64, DC_CALL_C_PPC64, DC_CALL_C_PPC64_LINUX, DC_CALL_SYS_DEFAULT, DC_CALL_SYS_X86_INT80H_LINUX, DC_CALL_SYS_X86_INT80H_BSD, DC_CALL_SYS_PPC32, DC_CALL_SYS_PPC64
Supported calling convention modes.
-
DC_ERROR_NONE, DC_ERROR_UNSUPPORTED_MODE
Error codes.
-
DC_SIGCHAR_VOID, DC_SIGCHAR_BOOL, DC_SIGCHAR_CHAR, DC_SIGCHAR_UCHAR, DC_SIGCHAR_SHORT, DC_SIGCHAR_USHORT, DC_SIGCHAR_INT, DC_SIGCHAR_UINT, DC_SIGCHAR_LONG, DC_SIGCHAR_ULONG, DC_SIGCHAR_LONGLONG, DC_SIGCHAR_ULONGLONG, DC_SIGCHAR_FLOAT, DC_SIGCHAR_DOUBLE, DC_SIGCHAR_POINTER, DC_SIGCHAR_STRING, DC_SIGCHAR_STRUCT, DC_SIGCHAR_ENDARG
Signatures.
-
-
Method Detail
-
dcNewCallVM
public static long dcNewCallVM(long size)
Creates a newCallVM
object.Use
Free
to destroy theCallVM
object.- Parameters:
size
- the max size of the internal stack that will be allocated and used to bind arguments to
-
ndcFree
public static void ndcFree(long vm)
Unsafe version of:Free
-
dcFree
public static void dcFree(long vm)
Frees aCallVM
object.- Parameters:
vm
- aCallVM
instance
-
ndcReset
public static void ndcReset(long vm)
Unsafe version of:Reset
-
dcReset
public static void dcReset(long vm)
Resets the internal stack of arguments and prepares it for a new call. This function should be called after setting the call mode (usingMode
), but prior to binding arguments to theCallVM
. Use it also when reusing aCallVM
, as arguments don’t get flushed automatically after a function call invocation.Note: you should also call this function after initial creation of the a
CallVM
object, asNewCallVM
doesn’t do this, implicitly.- Parameters:
vm
- aCallVM
instance
-
ndcMode
public static void ndcMode(long vm, int mode)
Unsafe version of:Mode
-
dcMode
public static void dcMode(long vm, int mode)
Sets the calling convention to use.CALL_C_DEFAULT
is the default standard C call on the target platform. It uses the standard C calling convention.CALL_C_ELLIPSIS
is used for C ellipsis calls which allow to build up a variable argument list. On many platforms, there is only one C calling convention. The X86 platform provides a rich family of different calling conventions.- Parameters:
vm
- aCallVM
instancemode
- the calling convention. One of:
-
ndcArgBool
public static void ndcArgBool(long vm, int value)
Unsafe version of:ArgBool
-
dcArgBool
public static void dcArgBool(long vm, boolean value)
Binds abool
argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgChar
public static void ndcArgChar(long vm, byte value)
Unsafe version of:ArgChar
-
dcArgChar
public static void dcArgChar(long vm, byte value)
Binds achar
argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgShort
public static void ndcArgShort(long vm, short value)
Unsafe version of:ArgShort
-
dcArgShort
public static void dcArgShort(long vm, short value)
Binds ashort
argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgInt
public static void ndcArgInt(long vm, int value)
Unsafe version of:ArgInt
-
dcArgInt
public static void dcArgInt(long vm, int value)
Binds anint
argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgLong
public static void ndcArgLong(long vm, long value)
Unsafe version of:ArgLong
-
dcArgLong
public static void dcArgLong(long vm, long value)
Binds along
argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgLongLong
public static void ndcArgLongLong(long vm, long value)
Unsafe version of:ArgLongLong
-
dcArgLongLong
public static void dcArgLongLong(long vm, long value)
Binds along long
argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgFloat
public static void ndcArgFloat(long vm, float value)
Unsafe version of:ArgFloat
-
dcArgFloat
public static void dcArgFloat(long vm, float value)
Binds afloat
argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgDouble
public static void ndcArgDouble(long vm, double value)
Unsafe version of:ArgDouble
-
dcArgDouble
public static void dcArgDouble(long vm, double value)
Binds adouble
argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgPointer
public static void ndcArgPointer(long vm, long value)
Unsafe version of:ArgPointer
-
dcArgPointer
public static void dcArgPointer(long vm, long value)
Binds a pointer argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcArgStruct
public static void ndcArgStruct(long vm, long s, long value)
Unsafe version of:ArgStruct
-
dcArgStruct
public static void dcArgStruct(long vm, long s, long value)
Binds a struct argument.- Parameters:
vm
- aCallVM
instancevalue
- the argument value
-
ndcCallVoid
public static void ndcCallVoid(long vm, long funcptr)
Unsafe version of:CallVoid
-
dcCallVoid
public static void dcCallVoid(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallBool
public static int ndcCallBool(long vm, long funcptr)
Unsafe version of:CallBool
-
dcCallBool
public static boolean dcCallBool(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallChar
public static byte ndcCallChar(long vm, long funcptr)
Unsafe version of:CallChar
-
dcCallChar
public static byte dcCallChar(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallShort
public static short ndcCallShort(long vm, long funcptr)
Unsafe version of:CallShort
-
dcCallShort
public static short dcCallShort(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallInt
public static int ndcCallInt(long vm, long funcptr)
Unsafe version of:CallInt
-
dcCallInt
public static int dcCallInt(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallLong
public static long ndcCallLong(long vm, long funcptr)
Unsafe version of:CallLong
-
dcCallLong
public static long dcCallLong(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallLongLong
public static long ndcCallLongLong(long vm, long funcptr)
Unsafe version of:CallLongLong
-
dcCallLongLong
public static long dcCallLongLong(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallFloat
public static float ndcCallFloat(long vm, long funcptr)
Unsafe version of:CallFloat
-
dcCallFloat
public static float dcCallFloat(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallDouble
public static double ndcCallDouble(long vm, long funcptr)
Unsafe version of:CallDouble
-
dcCallDouble
public static double dcCallDouble(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallPointer
public static long ndcCallPointer(long vm, long funcptr)
Unsafe version of:CallPointer
-
dcCallPointer
public static long dcCallPointer(long vm, long funcptr)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcCallStruct
public static void ndcCallStruct(long vm, long funcptr, long s, long returnValue)
Unsafe version of:CallStruct
-
dcCallStruct
public static void dcCallStruct(long vm, long funcptr, long s, long returnValue)
Calls the function specified byfuncptr
with the arguments bound to theCallVM
and returns.After the invocation of the foreign function call, the argument values are still bound and a second call using the same arguments can be issued. If you need to clear the argument bindings, you have to reset the
CallVM
.- Parameters:
vm
- aCallVM
instancefuncptr
- the function pointer
-
ndcGetError
public static int ndcGetError(long vm)
Unsafe version of:GetError
-
dcGetError
public static int dcGetError(long vm)
Returns the most recent error state code.- Parameters:
vm
- aCallVM
instance
-
dcNewStruct
public static long dcNewStruct(long fieldCount, int alignment)
Creates a new struct type.- Parameters:
fieldCount
- the number of fieldsalignment
- a custom struct alignment, or 0 to calculate automatically
-
ndcStructField
public static void ndcStructField(long s, int type, int alignment, long arrayLength)
Unsafe version of:StructField
-
dcStructField
public static void dcStructField(long s, int type, int alignment, long arrayLength)
Adds a field to the specified struct.- Parameters:
s
- the structtype
- the field type. One of:alignment
- a custom field alignment, or 0 to calculate automaticallyarrayLength
- 1 or a higher value if the field is an array
-
ndcSubStruct
public static void ndcSubStruct(long s, long fieldCount, int alignment, long arrayLength)
Unsafe version of:SubStruct
-
dcSubStruct
public static void dcSubStruct(long s, long fieldCount, int alignment, long arrayLength)
Adds a nested struct to the specified struct- Parameters:
s
- the structfieldCount
- the number of fields in the nested structalignment
- a custom nested struct alignment, or 0 to calculate automaticallyarrayLength
- 1 or a higher value if the nested struct is an array
-
ndcCloseStruct
public static void ndcCloseStruct(long s)
Unsafe version of:CloseStruct
-
dcCloseStruct
public static void dcCloseStruct(long s)
Completes the struct definition.- Parameters:
s
- the struct to close
-
ndcStructSize
public static long ndcStructSize(long s)
Unsafe version of:StructSize
-
dcStructSize
public static long dcStructSize(long s)
Returns the size, in bytes, of the specified struct.- Parameters:
s
- the struct
-
ndcStructAlignment
public static long ndcStructAlignment(long s)
Unsafe version of:StructAlignment
-
dcStructAlignment
public static long dcStructAlignment(long s)
Returns the alignment, in bytes, of the specified struct.- Parameters:
s
- the struct
-
ndcFreeStruct
public static void ndcFreeStruct(long s)
Unsafe version of:FreeStruct
-
dcFreeStruct
public static void dcFreeStruct(long s)
Frees the specified struct object.- Parameters:
s
- the struct to free
-
ndcDefineStruct
public static long ndcDefineStruct(long signature)
Unsafe version of:DefineStruct
-
dcDefineStruct
public static long dcDefineStruct(java.nio.ByteBuffer signature) public static long dcDefineStruct(java.lang.CharSequence signature)
Creates a new struct type using a signature string.- Parameters:
signature
- the struct signature
-
-