Package org.jruby.ext.ffi

Class StructLayout

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.ext.ffi.Type

org.jruby.ext.ffi.StructLayout

All Implemented Interfaces:

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

public final class StructLayout
extends Type

Defines the memory layout for a native structure.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StructLayout.ArrayField
(package private) static final class	StructLayout.ArrayFieldIO
static class	StructLayout.ArrayProxy
static final class	StructLayout.CharArrayProxy
(package private) static final class	StructLayout.DefaultFieldIO
static final class	StructLayout.EnumField
(package private) static final class	StructLayout.EnumFieldIO	Enum (maps :foo => 1, :bar => 2, etc)
static class	StructLayout.Field
(package private) static interface	StructLayout.FieldIO
static final class	StructLayout.FunctionField
(package private) static final class	StructLayout.FunctionFieldIO
static final class	StructLayout.InnerStructField
(package private) static final class	StructLayout.InnerStructFieldIO
(package private) static final class	StructLayout.MappedFieldIO
static final class	StructLayout.Member	A struct member.
(package private) static final class	StructLayout.MultiDimensionArrayOp
(package private) static class	StructLayout.NullStorage
static final class	StructLayout.NumberField
(package private) static final class	StructLayout.NumberFieldIO	Primitive (byte, short, int, long, float, double) types are all handled by a PrimitiveMember type.
static final class	StructLayout.PointerField
(package private) static final class	StructLayout.PointerFieldIO
static interface	StructLayout.Storage
(package private) static final class	StructLayout.StringField
(package private) static final class	StructLayout.StringFieldIO

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	Description
private final int	cacheableFieldCount	The number of cacheable fields in this struct
(package private) static final String	CLASS_NAME	The name to use to register this class in the JRuby runtime
private final List<IRubyObject>	fieldNames	The ordered list of field names (as symbols)
private final List<StructLayout.Field>	fields	The ordered list of fields
private final StructLayout.Member[]	identityLookupTable
private final boolean	isUnion
private final Map<IRubyObject,StructLayout.Member>	memberMap	The name:offset map for this struct
private final Collection<StructLayout.Member>	members	The ordered list of fields
(package private) static final StructLayout.Storage	nullStorage
private final int	referenceFieldCount	The number of reference fields in this struct

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

alignment, nativeType, size

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_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

Modifier	Constructor	Description
private	StructLayout(Ruby runtime, RubyClass klass, Collection<IRubyObject> fields, int size, int alignment)	Creates a new StructLayout instance.

Method Summary

Modifier and Type	Method	Description
IRubyObject	aref(ThreadContext context, IRubyObject fieldName)
static RubyClass	createStructLayoutClass(Ruby runtime, RubyModule module)	Registers the StructLayout class in the JRuby runtime.
boolean	equals(Object o)	This override does not do a "checked" dispatch.
IRubyObject	fields(ThreadContext context)
IRubyObject	get(ThreadContext context, IRubyObject ptr, IRubyObject name)	Gets the value of the struct member corresponding to name.
private static MemoryOp	getArrayComponentMemoryOp(Type.Array arrayType)
(package private) final int	getCacheableFieldCount()
(package private) final int	getCacheableFieldIndex(StructLayout.Member member)
(package private) final StructLayout.Field	getField(Ruby runtime, IRubyObject name)	Returns a StructLayout.Field descriptor for a struct field.
final int	getFieldCount()
final Collection<StructLayout.Field>	getFields()
(package private) final StructLayout.Member	getMember(Ruby runtime, IRubyObject name)	Returns a StructLayout.Member descriptor for a struct field.
final Collection<StructLayout.Member>	getMembers()
(package private) final int	getReferenceFieldCount()
(package private) final int	getReferenceFieldIndex(StructLayout.Member member)
final int	getSize()
(package private) final IRubyObject	getValue(ThreadContext context, IRubyObject name, StructLayout.Storage cache, IRubyObject ptr)
int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
final boolean	isUnion()
IRubyObject	members(ThreadContext context)	Gets a ruby array of the names of all members of this struct.
static final IRubyObject	newStructLayout(ThreadContext context, IRubyObject klass, IRubyObject[] args)
private static int	nextIndex(int idx, int length)
IRubyObject	offset_of(ThreadContext context, IRubyObject fieldName)
IRubyObject	offsets(ThreadContext context)	Gets a ruby array of the offsets of all members of this struct.
IRubyObject	put(ThreadContext context, IRubyObject ptr, IRubyObject name, IRubyObject value)	Sets the native value of the struct member corresponding to name.
(package private) final void	putValue(ThreadContext context, IRubyObject name, StructLayout.Storage cache, IRubyObject ptr, IRubyObject value)
private static int	symbolIndex(IRubyObject name, int length)
IRubyObject	union_bang(ThreadContext context)

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

alignment, createTypeClass, getNativeAlignment, getNativeAlignment, getNativeSize, 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, dig1, dig2, eqlInternal, equalInternal, getNativeClassIndex, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql, eql_p, 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, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, 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, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method, method_missing, method_missing19, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, 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, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, toJava, trust, type, type_deprecated, untaint, untrust, untrusted_p, validateInstanceVariable, 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 Details

nullStorage

static final StructLayout.Storage nullStorage

CLASS_NAME

static final String CLASS_NAME

The name to use to register this class in the JRuby runtime

See Also:

• Constant Field Values

identityLookupTable

private final StructLayout.Member[] identityLookupTable

memberMap

private final Map<IRubyObject,StructLayout.Member> memberMap

The name:offset map for this struct

fieldNames

private final List<IRubyObject> fieldNames

The ordered list of field names (as symbols)

fields

private final List<StructLayout.Field> fields

The ordered list of fields

members

private final Collection<StructLayout.Member> members

The ordered list of fields

cacheableFieldCount

private final int cacheableFieldCount

The number of cacheable fields in this struct

referenceFieldCount

private final int referenceFieldCount

The number of reference fields in this struct

isUnion

private final boolean isUnion

Constructor Details

StructLayout

private StructLayout(Ruby runtime,
 RubyClass klass,
 Collection<IRubyObject> fields,
 int size,
 int alignment)

Creates a new StructLayout instance.

Parameters:

runtime - The runtime for the StructLayout.

fields - The fields map for this struct.

size - the total size of the struct.

alignment - The minimum alignment required when allocating memory.

Method Details

createStructLayoutClass

public static RubyClass createStructLayoutClass(Ruby runtime,
 RubyModule module)

Registers the StructLayout class in the JRuby runtime.

Parameters:

runtime - The JRuby runtime to register the new class in.

Returns:

The new class

newStructLayout

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

get

public IRubyObject get(ThreadContext context,
 IRubyObject ptr,
 IRubyObject name)

Gets the value of the struct member corresponding to name.

Parameters:

ptr - The address of the structure in memory.

name - The name of the member.

Returns:

A ruby value for the native value of the struct member.

put

public IRubyObject put(ThreadContext context,
 IRubyObject ptr,
 IRubyObject name,
 IRubyObject value)

Sets the native value of the struct member corresponding to name.

Parameters:

ptr - The address of the structure in memory.

name - The name of the member.

Returns:

A ruby value for the native value of the struct member.

members

public IRubyObject members(ThreadContext context)

Gets a ruby array of the names of all members of this struct.

Returns:

a RubyArray containing the names of all members.

offsets

public IRubyObject offsets(ThreadContext context)

Gets a ruby array of the offsets of all members of this struct.

Returns:

a RubyArray containing the offsets of all members.

offset_of

public IRubyObject offset_of(ThreadContext context,
 IRubyObject fieldName)

aref

public IRubyObject aref(ThreadContext context,
 IRubyObject fieldName)

fields

public IRubyObject fields(ThreadContext context)

union_bang

public IRubyObject union_bang(ThreadContext context)

getValue

final IRubyObject getValue(ThreadContext context,
 IRubyObject name,
 StructLayout.Storage cache,
 IRubyObject ptr)

putValue

final void putValue(ThreadContext context,
 IRubyObject name,
 StructLayout.Storage cache,
 IRubyObject ptr,
 IRubyObject value)

equals

public boolean equals(Object o)

Description copied from class: RubyObject

This override does not do a "checked" dispatch.

Overrides:

equals in class RubyObject

See Also:

• RubyBasicObject.equals(Object)

hashCode

public int hashCode()

Description copied from class: RubyObject

This override does not do "checked" dispatch since Object usually has #hash defined.

Overrides:

hashCode in class RubyObject

See Also:

• RubyBasicObject.hashCode()

symbolIndex

private static int symbolIndex(IRubyObject name,
 int length)

nextIndex

private static int nextIndex(int idx,
 int length)

getMember

final StructLayout.Member getMember(Ruby runtime,
 IRubyObject name)

Returns a StructLayout.Member descriptor for a struct field.

Parameters:

name - The name of the struct field.

Returns:

A Member descriptor.

getField

final StructLayout.Field getField(Ruby runtime,
 IRubyObject name)

Returns a StructLayout.Field descriptor for a struct field.

Parameters:

name - The name of the struct field.

Returns:

A Member descriptor.

getSize

public final int getSize()

getReferenceFieldCount

final int getReferenceFieldCount()

getReferenceFieldIndex

final int getReferenceFieldIndex(StructLayout.Member member)

getCacheableFieldCount

final int getCacheableFieldCount()

getCacheableFieldIndex

final int getCacheableFieldIndex(StructLayout.Member member)

getFieldCount

public final int getFieldCount()

getFields

public final Collection<StructLayout.Field> getFields()

getMembers

public final Collection<StructLayout.Member> getMembers()

isUnion

public final boolean isUnion()

getArrayComponentMemoryOp

private static MemoryOp getArrayComponentMemoryOp(Type.Array arrayType)