org.jruby.ext.ffi
Class StructLayout

java.lang.Object
  org.jruby.RubyBasicObject
      org.jruby.RubyObject
          org.jruby.ext.ffi.StructLayout

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public final class StructLayout
extends RubyObject

Defines the memory layout for a native structure.

See Also:

Serialized Form

Nested Class Summary

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

RubyObject.ObjectMethods

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

RubyBasicObject.BasicObjectMethods, RubyBasicObject.Finalizer, RubyBasicObject.VariableTableEntry

Field Summary

Fields inherited from class org.jruby.RubyObject

OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, dataStruct, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, metaClass, NEVER, NIL_F, TAINTED_F, UNDEF, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, VARIABLE_TABLE_DEFAULT_CAPACITY, VARIABLE_TABLE_EMPTY_TABLE, VARIABLE_TABLE_LOAD_FACTOR, VARIABLE_TABLE_MAXIMUM_CAPACITY, variableTable, variableTableSize, variableTableThreshold

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

NULL_ARRAY

Method Summary

static RubyClass	createStructLayoutClass(Ruby runtime, RubyModule module) Registers the StructLayout class in the JRuby runtime.
IRubyObject	get(ThreadContext context, IRubyObject ptr, IRubyObject name) Gets the value of the struct member corresponding to name.
IRubyObject	members(ThreadContext context) Gets a ruby array of the names 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.
IRubyObject	size(ThreadContext context) Gets the total size of the struct.

Methods inherited from class org.jruby.RubyObject

as, attachToObjectSpace, callInit, checkFrozen, convertToType, createObjectClass, display, dup, eql_p, eqlInternal, equal_p, equalInternal, equals, evalUnder, evalUnder, extend, freeze, frozen_p, getNativeTypeIndex, hash, hashCode, id_deprecated, id, initialize_copy, initialize, inspect, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, kind_of_p, method, methods, nil_p, op_eqq, op_equal, op_match, private_methods, protected_methods, public_methods, puts, rbClone, remove_instance_variable, respond_to_p, respond_to_p, send, send, send, send, send, singleton_methods, singleton_methods19, singletonMethods, specificEval, specificEval, specificEval, specificEval, specificEval, taint, tainted_p, to_a, to_java, to_s, toString, type_deprecated, type, untaint, validateInstanceVariable

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkStringType, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataWrapStruct, ensureInstanceVariablesSettable, eql, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, getFlag, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariableList, getInternalVariables, getJavaClass, getMetaClass, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariableCount, getVariableList, getVariableMap, getVariableNameList, hasInstanceVariable, hasInternalVariable, hasVariables, infectBy, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isRubyVariable, isTaint, isTrue, makeMetaClass, op_not_equal, op_not, removeFinalizers, removeInstanceVariable, removeInternalVariable, respondsTo, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setTaint, syncVariables, taint, testFrozen, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableGetMap, variableTableGetMap, variableTableGetSize, variableTableGetTable, variableTableReadLocked, variableTableRehash, variableTableRemove, variableTableStore, variableTableSync

Methods inherited from class java.lang.Object

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

Method Detail

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

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.

size

public IRubyObject size(ThreadContext context)

Gets the total size of the struct.

Returns:

The size of the struct.