org.jruby.ext.ffi

Class CallbackInfo

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.ext.ffi.Type

org.jruby.ext.ffi.CallbackInfo

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class CallbackInfo
extends Type

Defines a C callback's parameters and return type.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.ext.ffi.Type

Type.Array, Type.Builtin

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field and Description
protected Arity	arity The arity of this function.
static String	CLASS_NAME
protected Type[]	parameterTypes
protected Type	returnType
protected boolean	stdcall

Fields inherited from class org.jruby.ext.ffi.Type

alignment, nativeType, size

Fields inherited from class org.jruby.RubyObject

FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Constructor and Description
CallbackInfo(Ruby runtime, RubyClass klazz, Type returnType, Type[] paramTypes, boolean stdcall) Creates a new CallbackInfo instance.

Method Summary

Modifier and Type	Method and Description
static RubyClass	createCallbackInfoClass(Ruby runtime, RubyModule module) Creates a CallbackInfo class for a ruby runtime
Arity	getArity() Returns the Arity of this function.
Type[]	getParameterTypes() Gets the ruby parameter types of the callback
Type	getReturnType() Gets the native return type the callback should return
boolean	isStdcall()
static IRubyObject	newCallbackInfo(ThreadContext context, IRubyObject klass, IRubyObject[] args) CallbackInfo.new
IRubyObject	param_types(ThreadContext context)
IRubyObject	result_type(ThreadContext context)
IRubyObject	to_s(ThreadContext context)
String	toString() The default toString method is just a wrapper that calls the Ruby "to_s" method.

Methods inherited from class org.jruby.ext.ffi.Type

alignment, createTypeClass, getNativeAlignment, getNativeSize, getNativeType, getTypeClass, size

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, eqlInternal, equalInternal, equals, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, display, dup, ensureInstanceVariablesSettable, eql_p, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize_copy, initialize, initialize, initialize19, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_equal, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, toJava, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_NAME

public static final String CLASS_NAME

See Also:

Constant Field Values

arity

protected final Arity arity

The arity of this function.

parameterTypes

protected final Type[] parameterTypes

returnType

protected final Type returnType

stdcall

protected final boolean stdcall

Constructor Detail

CallbackInfo

public CallbackInfo(Ruby runtime,
                    RubyClass klazz,
                    Type returnType,
                    Type[] paramTypes,
                    boolean stdcall)

Creates a new CallbackInfo instance.

Parameters:

runtime - The runtime to create the instance for

klazz - The ruby class of the CallbackInfo instance

returnType - The return type of the callback

paramTypes - The parameter types of the callback

Method Detail

createCallbackInfoClass

public static RubyClass createCallbackInfoClass(Ruby runtime,
                                                RubyModule module)

Creates a CallbackInfo class for a ruby runtime

Parameters:

runtime - The runtime to create the class for

module - The module to place the class in

Returns:

The newly created ruby class

newCallbackInfo

public static final IRubyObject newCallbackInfo(ThreadContext context,
                                                IRubyObject klass,
                                                IRubyObject[] args)

CallbackInfo.new

Parameters:

context - The current ruby thread context

klass - The ruby class of the CallbackInfo instance

returnType - The ruby return type

paramTypes - An array containing the ruby parameter types

Returns:

A new CallbackInfo instance

getArity

public final Arity getArity()

Returns the Arity of this function.

Returns:

The Arity of the native function.

getReturnType

public final Type getReturnType()

Gets the native return type the callback should return

Returns:

The native return type

getParameterTypes

public final Type[] getParameterTypes()

Gets the ruby parameter types of the callback

Returns:

An array of the parameter types

isStdcall

public final boolean isStdcall()

to_s

public final IRubyObject to_s(ThreadContext context)

toString

public final String toString()

Description copied from class: RubyObject

The default toString method is just a wrapper that calls the Ruby "to_s" method.

Overrides:

toString in class RubyObject

result_type

public final IRubyObject result_type(ThreadContext context)

param_types

public final IRubyObject param_types(ThreadContext context)