Package org.jruby.ext.ffi

Class Struct

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.ext.ffi.MemoryObject

org.jruby.ext.ffi.Struct

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, StructLayout.Storage, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class Struct
extends MemoryObject
implements StructLayout.Storage

See Also:

• Serialized Form

Nested Class Summary

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 StructLayout	layout
private AbstractMemory	memory
private Object[]	referenceCache
private static final AtomicReferenceFieldUpdater<Struct,Object[]>	referenceCacheUpdater
private IRubyObject[]	valueCache
private static final AtomicReferenceFieldUpdater<Struct,IRubyObject[]>	valueCacheUpdater

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

Constructor	Description
Struct(Ruby runtime)	Creates a new StructLayout instance using defaults.
Struct(Ruby runtime, RubyClass klass)	Creates a new StructLayout instance.
Struct(Ruby runtime, RubyClass klass, StructLayout layout, IRubyObject memory)	Creates a new StructLayout instance.

Method Summary

Modifier and Type	Method	Description
IRubyObject	alignment(ThreadContext context)
static IRubyObject	alignment(ThreadContext context, IRubyObject structClass)
static IRubyObject	allocateIn(ThreadContext context, IRubyObject klass)
static IRubyObject	allocateIn(ThreadContext context, IRubyObject klass, IRubyObject clearArg)
static IRubyObject	allocateInOut(ThreadContext context, IRubyObject klass)
static IRubyObject	allocateInOut(ThreadContext context, IRubyObject klass, IRubyObject clearArg)
protected final MemoryIO	allocateMemoryIO()
static IRubyObject	allocateOut(ThreadContext context, IRubyObject klass)
static IRubyObject	allocateOut(ThreadContext context, IRubyObject klass, IRubyObject clearArg)
private static final Struct	allocateStruct(ThreadContext context, IRubyObject klass, int flags)
IRubyObject	clear(ThreadContext context)
static RubyClass	createStructClass(Ruby runtime, RubyModule module)	Registers the StructLayout class in the JRuby runtime.
final IRubyObject	getCachedValue(StructLayout.Member member)
IRubyObject	getFieldValue(ThreadContext context, IRubyObject fieldName)
IRubyObject	getLayout(ThreadContext context)
final AbstractMemory	getMemory()
private Object[]	getReferenceCache()
(package private) static final StructLayout	getStructLayout(Ruby runtime, IRubyObject structClass)
(package private) static final int	getStructSize(Ruby runtime, IRubyObject structClass)
private IRubyObject[]	getValueCacheForWrite()
IRubyObject	initialize(ThreadContext context)
IRubyObject	initialize(ThreadContext context, IRubyObject ptr)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args)
IRubyObject	initialize_copy(ThreadContext context, IRubyObject other)
private Object[]	initReferenceCache()
private IRubyObject[]	initValueCache()
(package private) static final boolean	isStruct(Ruby runtime, RubyClass klass)
IRubyObject	members(ThreadContext context)
static IRubyObject	members(ThreadContext context, IRubyObject structClass)
IRubyObject	null_p(ThreadContext context)
IRubyObject	offset_of(ThreadContext context, IRubyObject fieldName)
static IRubyObject	offset_of(ThreadContext context, IRubyObject structClass, IRubyObject fieldName)
IRubyObject	offsets(ThreadContext context)
static IRubyObject	offsets(ThreadContext context, IRubyObject structClass)
final IRubyObject	order(ThreadContext context)
final IRubyObject	order(ThreadContext context, IRubyObject byte_order)
IRubyObject	pointer(ThreadContext context)
final void	putCachedValue(StructLayout.Member member, IRubyObject value)
void	putReference(StructLayout.Member member, Object value)
static IRubyObject	set_layout(ThreadContext context, IRubyObject structClass, IRubyObject layout)
IRubyObject	setFieldValue(ThreadContext context, IRubyObject fieldName, IRubyObject fieldValue)
IRubyObject	size(ThreadContext context)
static IRubyObject	size(ThreadContext context, IRubyObject structClass)
IRubyObject	values(ThreadContext context)

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

getMemoryIO, setMemoryIO

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, equals, getNativeClassIndex, hashCode, 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_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

layout

private StructLayout layout

memory

private AbstractMemory memory

referenceCache

private volatile Object[] referenceCache

valueCache

private volatile IRubyObject[] valueCache

valueCacheUpdater

private static final AtomicReferenceFieldUpdater<Struct,IRubyObject[]> valueCacheUpdater

referenceCacheUpdater

private static final AtomicReferenceFieldUpdater<Struct,Object[]> referenceCacheUpdater

Constructor Details

Struct

Struct(Ruby runtime)

Creates a new StructLayout instance using defaults.

Parameters:

runtime - The runtime for the StructLayout

Struct

public Struct(Ruby runtime,
 RubyClass klass)

Creates a new StructLayout instance.

Parameters:

runtime - The runtime for the StructLayout

klass - the ruby class to use for the StructLayout

Struct

Struct(Ruby runtime,
 RubyClass klass,
 StructLayout layout,
 IRubyObject memory)

Creates a new StructLayout instance.

Parameters:

runtime - The runtime for the StructLayout

klass - the ruby class to use for the StructLayout

Method Details

createStructClass

public static RubyClass createStructClass(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

isStruct

static final boolean isStruct(Ruby runtime,
 RubyClass klass)

getStructSize

static final int getStructSize(Ruby runtime,
 IRubyObject structClass)

getStructLayout

static final StructLayout getStructLayout(Ruby runtime,
 IRubyObject structClass)

initialize

public IRubyObject initialize(ThreadContext context)

Overrides:

initialize in class RubyBasicObject

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject ptr)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject[] args)

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject other)

allocateStruct

private static final Struct allocateStruct(ThreadContext context,
 IRubyObject klass,
 int flags)

allocateIn

public static IRubyObject allocateIn(ThreadContext context,
 IRubyObject klass)

allocateIn

public static IRubyObject allocateIn(ThreadContext context,
 IRubyObject klass,
 IRubyObject clearArg)

allocateOut

public static IRubyObject allocateOut(ThreadContext context,
 IRubyObject klass)

allocateOut

public static IRubyObject allocateOut(ThreadContext context,
 IRubyObject klass,
 IRubyObject clearArg)

allocateInOut

public static IRubyObject allocateInOut(ThreadContext context,
 IRubyObject klass)

allocateInOut

public static IRubyObject allocateInOut(ThreadContext context,
 IRubyObject klass,
 IRubyObject clearArg)

size

public static IRubyObject size(ThreadContext context,
 IRubyObject structClass)

alignment

public static IRubyObject alignment(ThreadContext context,
 IRubyObject structClass)

set_layout

public static IRubyObject set_layout(ThreadContext context,
 IRubyObject structClass,
 IRubyObject layout)

members

public static IRubyObject members(ThreadContext context,
 IRubyObject structClass)

offsets

public static IRubyObject offsets(ThreadContext context,
 IRubyObject structClass)

offset_of

public static IRubyObject offset_of(ThreadContext context,
 IRubyObject structClass,
 IRubyObject fieldName)

getFieldValue

public IRubyObject getFieldValue(ThreadContext context,
 IRubyObject fieldName)

setFieldValue

public IRubyObject setFieldValue(ThreadContext context,
 IRubyObject fieldName,
 IRubyObject fieldValue)

getLayout

public IRubyObject getLayout(ThreadContext context)

pointer

public IRubyObject pointer(ThreadContext context)

members

public IRubyObject members(ThreadContext context)

values

public IRubyObject values(ThreadContext context)

offsets

public IRubyObject offsets(ThreadContext context)

offset_of

public IRubyObject offset_of(ThreadContext context,
 IRubyObject fieldName)

size

public IRubyObject size(ThreadContext context)

alignment

public IRubyObject alignment(ThreadContext context)

null_p

public IRubyObject null_p(ThreadContext context)

order

public final IRubyObject order(ThreadContext context)

order

public final IRubyObject order(ThreadContext context,
 IRubyObject byte_order)

clear

public IRubyObject clear(ThreadContext context)

getMemory

public final AbstractMemory getMemory()

allocateMemoryIO

protected final MemoryIO allocateMemoryIO()

Specified by:

allocateMemoryIO in class MemoryObject

getCachedValue

public final IRubyObject getCachedValue(StructLayout.Member member)

Specified by:

getCachedValue in interface StructLayout.Storage

putCachedValue

public final void putCachedValue(StructLayout.Member member,
 IRubyObject value)

Specified by:

putCachedValue in interface StructLayout.Storage

getValueCacheForWrite

private IRubyObject[] getValueCacheForWrite()

initValueCache

private IRubyObject[] initValueCache()

getReferenceCache

private Object[] getReferenceCache()

initReferenceCache

private Object[] initReferenceCache()

putReference

public void putReference(StructLayout.Member member,
 Object value)

Specified by:

putReference in interface StructLayout.Storage