Top Inners Fields Constructors Methods
org.python.modules.jffi

public Class Function

extends BasePointer
implements Traverseproc
Class Inheritance
All Implemented Interfaces
org.python.core.Traverseproc
Annotations
@ExposedType
name:jffi.Function
base:PyObject
Imports
com.kenai.jffi.CallingConvention, org.python.core.Py, .PyList, .PyNewWrapper, .PyObject, .PySequenceList, .PyStringMap, .PyType, .Traverseproc, .Visitproc, org.python.expose.ExposedGet, .ExposedNew, .ExposedSet, .ExposedType

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
Function.ErrCheckInvoker

Field Summary

Modifier and TypeField and Description
private volatile PyObject[]
argtypes

private Invoker
compiledInvoker

private Invoker
defaultInvoker

private final PyStringMap
dict

public PyObject
errcheck

private volatile Function
jffiFunction

private volatile JITHandle
jitHandle

private final DynamicLibrary
library

public final String
name

private final Pointer
pointer

private volatile PyObject
restype

public static final PyType
TYPE

Hides org.python.core.PyObject.TYPE.

Constructor Summary

AccessConstructor and Description
pack-priv
Function(PyType type, Pointer address)

pack-priv
Function(PyType type, DynamicLibrary.Symbol sym)

Method Summary

Modifier and TypeMethod and Description
public PyObject
__call__(PyObject[]
all arguments to the function (including keyword arguments).
args, String[]
the keywords used for all keyword arguments.
keywords)

Overrides org.python.core.PyObject.__call__.

The basic method to override when implementing a callable object.

public PyObject
__call__()

Overrides org.python.core.PyObject.__call__.

A variant of the __call__ method with no arguments.

public PyObject
__call__(PyObject
the single argument to the function.
arg0)

Overrides org.python.core.PyObject.__call__.

A variant of the __call__ method with one argument.

public PyObject
__call__(PyObject
the first argument to the function.
arg0, PyObject
the second argument to the function.
arg1)

Overrides org.python.core.PyObject.__call__.

A variant of the __call__ method with two arguments.

public PyObject
__call__(PyObject
the first argument to the function.
arg0, PyObject
the second argument to the function.
arg1, PyObject
the third argument to the function.
arg2)

Overrides org.python.core.PyObject.__call__.

A variant of the __call__ method with three arguments.

public PyObject
__call__(PyObject
the first argument to the function.
arg0, PyObject
the second argument to the function.
arg1, PyObject
the third argument to the function.
arg2, PyObject
the fourth argument to the function.
arg3)

Overrides org.python.core.PyObject.__call__.

A variant of the __call__ method with four arguments.

public boolean
__nonzero__()

Overrides org.python.modules.jffi.BasePointer.__nonzero__.

Equivalent to the standard Python __nonzero__ method.

public void
errcheck(PyObject errcheck)

public PyObject
fastGetDict()

Overrides org.python.core.PyObject.fastGetDict.

xxx implements where meaningful

public static PyObject
Function_new(PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords)

public PyObject
getArgTypes()

public PyObject
getDict()

Overrides org.python.core.PyObject.getDict.

xxx implements where meaningful

protected final Invoker
getInvoker()

public DirectMemory
getMemory()

Implements org.python.modules.jffi.Pointer.getMemory.

public PyObject
getResultType()

private synchronized void
invalidateInvoker()

public boolean
refersDirectlyTo(PyObject ob)

Implements org.python.core.Traverseproc.refersDirectlyTo.

Optional operation.

public void
setArgTypes(PyObject parameterTypes)

public void
setResultType(PyObject restype)

public int
traverse(Visitproc visit, Object arg)

Implements org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects.

private synchronized Invoker
tryCompilation()

Inherited from org.python.modules.jffi.BasePointer:
__int____long__address

Field Detail

argtypesback to summary
private volatile PyObject[] argtypes
compiledInvokerback to summary
private Invoker compiledInvoker
defaultInvokerback to summary
private Invoker defaultInvoker
dictback to summary
private final PyStringMap dict
errcheckback to summary
public PyObject errcheck
Annotations
@ExposedGet
jffiFunctionback to summary
private volatile Function jffiFunction
jitHandleback to summary
private volatile JITHandle jitHandle
libraryback to summary
private final DynamicLibrary library
nameback to summary
public final String name
Annotations
@ExposedGet
pointerback to summary
private final Pointer pointer
restypeback to summary
private volatile PyObject restype
TYPEback to summary
public static final PyType TYPE

Hides org.python.core.PyObject.TYPE.

Constructor Detail

Functionback to summary
pack-priv Function(PyType type, Pointer address)
Functionback to summary
pack-priv Function(PyType type, DynamicLibrary.Symbol sym)

Method Detail

__call__back to summary
public PyObject __call__(PyObject[] args, String[] keywords)

Overrides org.python.core.PyObject.__call__.

Doc from org.python.core.PyObject.__call__.

The basic method to override when implementing a callable object. The first len(args)-len(keywords) members of args[] are plain arguments. The last len(keywords) arguments are the values of the keyword arguments.

Parameters
args:PyObject[]

all arguments to the function (including keyword arguments).

keywords:String[]

the keywords used for all keyword arguments.

Annotations
@Override
__call__back to summary
public PyObject __call__()

Overrides org.python.core.PyObject.__call__.

Doc from org.python.core.PyObject.__call__.

A variant of the __call__ method with no arguments. The default behavior is to invoke __call__(args, keywords) with the appropriate arguments. The only reason to override this function would be for improved performance.

Annotations
@Override
__call__back to summary
public PyObject __call__(PyObject arg0)

Overrides org.python.core.PyObject.__call__.

Doc from org.python.core.PyObject.__call__.

A variant of the __call__ method with one argument. The default behavior is to invoke __call__(args, keywords) with the appropriate arguments. The only reason to override this function would be for improved performance.

Parameters
arg0:PyObject

the single argument to the function.

Annotations
@Override
__call__back to summary
public PyObject __call__(PyObject arg0, PyObject arg1)

Overrides org.python.core.PyObject.__call__.

Doc from org.python.core.PyObject.__call__.

A variant of the __call__ method with two arguments. The default behavior is to invoke __call__(args, keywords) with the appropriate arguments. The only reason to override this function would be for improved performance.

Parameters
arg0:PyObject

the first argument to the function.

arg1:PyObject

the second argument to the function.

Annotations
@Override
__call__back to summary
public PyObject __call__(PyObject arg0, PyObject arg1, PyObject arg2)

Overrides org.python.core.PyObject.__call__.

Doc from org.python.core.PyObject.__call__.

A variant of the __call__ method with three arguments. The default behavior is to invoke __call__(args, keywords) with the appropriate arguments. The only reason to override this function would be for improved performance.

Parameters
arg0:PyObject

the first argument to the function.

arg1:PyObject

the second argument to the function.

arg2:PyObject

the third argument to the function.

Annotations
@Override
__call__back to summary
public PyObject __call__(PyObject arg0, PyObject arg1, PyObject arg2, PyObject arg3)

Overrides org.python.core.PyObject.__call__.

Doc from org.python.core.PyObject.__call__.

A variant of the __call__ method with four arguments. The default behavior is to invoke __call__(args, keywords) with the appropriate arguments. The only reason to override this function would be for improved performance.

Parameters
arg0:PyObject

the first argument to the function.

arg1:PyObject

the second argument to the function.

arg2:PyObject

the third argument to the function.

arg3:PyObject

the fourth argument to the function.

Annotations
@Override
__nonzero__back to summary
public boolean __nonzero__()

Overrides org.python.modules.jffi.BasePointer.__nonzero__.

Doc from org.python.core.PyObject.__nonzero__.

Equivalent to the standard Python __nonzero__ method. Returns whether of not a given PyObject is considered true.

Annotations
@Override
errcheckback to summary
public void errcheck(PyObject errcheck)
Annotations
@ExposedSet
name:errcheck
fastGetDictback to summary
public PyObject fastGetDict()

Overrides org.python.core.PyObject.fastGetDict.

Doc from org.python.core.PyObject.fastGetDict.

xxx implements where meaningful

Returns:PyObject

internal object per instance dict or null

Annotations
@Override

Function_newback to summary
public static PyObject Function_new(PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords)
Annotations
@ExposedNew
getArgTypesback to summary
public PyObject getArgTypes()
Annotations
@ExposedGet
name:argtypes
getDictback to summary
public PyObject getDict()

Overrides org.python.core.PyObject.getDict.

Doc from org.python.core.PyObject.getDict.

xxx implements where meaningful

Returns:PyObject

internal object __dict__ or null

Annotations
@Override

getInvokerback to summary
protected final Invoker getInvoker()
getMemoryback to summary
public DirectMemory getMemory()

Implements org.python.modules.jffi.Pointer.getMemory.

getResultTypeback to summary
public PyObject getResultType()
Annotations
@ExposedGet
name:restype
invalidateInvokerback to summary
private synchronized void invalidateInvoker()
refersDirectlyToback to summary
public boolean refersDirectlyTo(PyObject ob) throws UnsupportedOperationException

Implements org.python.core.Traverseproc.refersDirectlyTo.

Doc from org.python.core.Traverseproc.refersDirectlyTo.

Optional operation. Should only be implemented if it is more efficient than calling traverse(Visitproc, Object) with a visitproc that just watches out for ob. Must return false if ob is null.

Annotations
@Override
setArgTypesback to summary
public void setArgTypes(PyObject parameterTypes)
Annotations
@ExposedSet
name:argtypes
setResultTypeback to summary
public void setResultType(PyObject restype)
Annotations
@ExposedSet
name:restype
traverseback to summary
public int traverse(Visitproc visit, Object arg)

Implements org.python.core.Traverseproc.traverse.

Doc from org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects. Like in CPython, arg must be passed unmodified to visit as its second parameter. If Visitproc#visit(PyObject, Object) returns nonzero, this return value must be returned immediately by traverse. Visitproc#visit(PyObject, Object) must not be called with a null PyObject-argument.

Annotations
@Override
tryCompilationback to summary
private synchronized Invoker tryCompilation()
org.python.modules.jffi back to summary

private final Class Function.ErrCheckInvoker

extends Invoker
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final PyObject
errcheck

private final Invoker
invoker

Constructor Summary

AccessConstructor and Description
public
ErrCheckInvoker(Invoker invoker, PyObject errcheck)

Method Summary

Modifier and TypeMethod and Description
public PyObject
invoke(PyObject[] args)

Implements abstract org.python.modules.jffi.Invoker.invoke.

public PyObject
invoke()

Implements abstract org.python.modules.jffi.Invoker.invoke.

public PyObject
invoke(PyObject arg1)

Implements abstract org.python.modules.jffi.Invoker.invoke.

public PyObject
invoke(PyObject arg1, PyObject arg2)

Implements abstract org.python.modules.jffi.Invoker.invoke.

public PyObject
invoke(PyObject arg1, PyObject arg2, PyObject arg3)

Implements abstract org.python.modules.jffi.Invoker.invoke.

public PyObject
invoke(PyObject arg1, PyObject arg2, PyObject arg3, PyObject arg4)

Implements abstract org.python.modules.jffi.Invoker.invoke.

public PyObject
invoke(PyObject arg1, PyObject arg2, PyObject arg3, PyObject arg4, PyObject arg5)

Implements abstract org.python.modules.jffi.Invoker.invoke.

public PyObject
invoke(PyObject arg1, PyObject arg2, PyObject arg3, PyObject arg4, PyObject arg5, PyObject arg6)

Implements abstract org.python.modules.jffi.Invoker.invoke.

Field Detail

errcheckback to summary
private final PyObject errcheck
invokerback to summary
private final Invoker invoker

Constructor Detail

ErrCheckInvokerback to summary
public ErrCheckInvoker(Invoker invoker, PyObject errcheck)

Method Detail

invokeback to summary
public PyObject invoke(PyObject[] args)

Implements abstract org.python.modules.jffi.Invoker.invoke.

invokeback to summary
public PyObject invoke()

Implements abstract org.python.modules.jffi.Invoker.invoke.

invokeback to summary
public PyObject invoke(PyObject arg1)

Implements abstract org.python.modules.jffi.Invoker.invoke.

invokeback to summary
public PyObject invoke(PyObject arg1, PyObject arg2)

Implements abstract org.python.modules.jffi.Invoker.invoke.

invokeback to summary
public PyObject invoke(PyObject arg1, PyObject arg2, PyObject arg3)

Implements abstract org.python.modules.jffi.Invoker.invoke.

invokeback to summary
public PyObject invoke(PyObject arg1, PyObject arg2, PyObject arg3, PyObject arg4)

Implements abstract org.python.modules.jffi.Invoker.invoke.

invokeback to summary
public PyObject invoke(PyObject arg1, PyObject arg2, PyObject arg3, PyObject arg4, PyObject arg5)

Implements abstract org.python.modules.jffi.Invoker.invoke.

invokeback to summary
public PyObject invoke(PyObject arg1, PyObject arg2, PyObject arg3, PyObject arg4, PyObject arg5, PyObject arg6)

Implements abstract org.python.modules.jffi.Invoker.invoke.