VariableTableManager

Field Summary

Fields
Modifier and Type	Field and Description
`private VariableAccessorField`	`cextHandleVariableAccessorField` a lazy accessor for C ext handle
`private static java.lang.String[]`	`EMPTY_STRING_ARRAY` an empty array of String
`private VariableAccessorField`	`ffiHandleVariableAccessorField` a lazy accessor for FFI handle
`private int`	`fieldVariables` whether objects associated with this table use fields
`private boolean`	`hasObjectID` whether a slot has been allocated to object_id
`private VariableAccessorField`	`objectGroupVariableAccessorField` a lazy accessor for object group
`private VariableAccessorField`	`objectIdVariableAccessorField` a lazy accessor for object_id
`private RubyClass`	`realClass` the "real" class associated with this table
`private java.util.Map<java.lang.String,VariableAccessor>`	`variableAccessors` a map from strings to accessors for this table
`private java.lang.String[]`	`variableNames` an array of all registered variable names

Constructor Summary

Constructors
Constructor and Description

VariableTableManager(RubyClass realClass)
Construct a new VariableTable Manager for the given "real" class.

Constructors
Constructor and Description
`VariableTableManager(RubyClass realClass)` Construct a new VariableTable Manager for the given "real" class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) VariableAccessor`	`allocateVariableAccessor(java.lang.String name)` Allocate a new VariableAccessor for the named variable.
`(package private) VariableAccessor`	`allocateVariableAccessorForVar(java.lang.String name, int index)`
`java.lang.Object`	`clearVariable(RubyBasicObject object, java.lang.String name)`
`void`	`deserializeVariables(RubyBasicObject object, java.io.ObjectInputStream ois)`
`java.lang.Object`	`getFFIHandle(RubyBasicObject self)` Retrieve the FFI ext handle for the given object.
`VariableAccessorField`	`getFFIHandleAccessorField()` Retrieve the lazy accessor (VariableAccessorField) for FFI handle.
`VariableAccessor`	`getFFIHandleAccessorForRead()` Retrieve the read accessor for FFI handle.
`VariableAccessor`	`getFFIHandleAccessorForWrite()` Retrieve the write accessor for FFI handle.
`java.lang.Object`	`getNativeHandle(RubyBasicObject self)` Retrieve the C ext handle for the given object.
`VariableAccessorField`	`getNativeHandleAccessorField()` Retrieve the lazy accessor (VariableAccessorField) for C ext handle.
`VariableAccessor`	`getNativeHandleAccessorForRead()` Retrieve the read accessor for C ext handle.
`VariableAccessor`	`getNativeHandleAccessorForWrite()` Retrieve the write accessor for C ext handle.
`VariableAccessorField`	`getObjectGroupAccessorField()` Retrieve the lazy accessor (VariableAccessorField) for object group.
`VariableAccessor`	`getObjectGroupAccessorForRead()` Retrieve the read accessor for object group.
`VariableAccessor`	`getObjectGroupAccessorForWrite()` Retrieve the write accessor for object group.
`long`	`getObjectId(RubyBasicObject self)` Get the object_id from a given RubyBasicObject, possibly allocating space for it.
`VariableAccessorField`	`getObjectIdAccessorField()` Retrieve the lazy accessor (VariableAccessorField) for object_id.
`VariableAccessor`	`getVariableAccessorForRead(java.lang.String name)` Get the variable accessor for the given name with intent to use it for reading.
`VariableAccessor`	`getVariableAccessorForVar(java.lang.String name, int index)`
`VariableAccessor`	`getVariableAccessorForWrite(java.lang.String name)` Get the variable accessor for the given name with intent to use it for writing.
`java.util.Map<java.lang.String,VariableAccessor>`	`getVariableAccessorsForRead()` Get the map of all current variable accessors with intent to read from it.
`java.lang.String[]`	`getVariableNames()` Get an array of all the known instance variable names.
`java.util.Map<java.lang.String,VariableAccessor>`	`getVariableTableCopy()` Get a Map representing all variables registered in the variable table.
`int`	`getVariableTableSize()` Get the size of the variable table, excluding extra vars (object_id, etc).
`int`	`getVariableTableSizeWithExtras()` Get the size of the variable table, including extra vars (object_etc, etc).
`boolean`	`hasObjectID()` Whether this table has been used to allocate space for an object_id.
`boolean`	`hasVariables(RubyBasicObject object)` Returns true if object has any variables, defined as: instance variables class variables constants internal variables, such as those used when marshaling Ranges and Exceptions
`private long`	`initObjectId(RubyBasicObject self, VariableAccessor objectIdAccessor)` We lazily stand up the object ID since it forces us to stand up per-object state for a given object.
`private static java.lang.Object[]`	`makeSyncedTable(java.lang.Object[] currentTable, java.lang.Object[] otherTable, int objectIdIdx)` Make a new variable table based on the values in a current and other (incoming) table, excluding object_id at specified index.
`void`	`serializeVariables(RubyBasicObject object, java.io.ObjectOutputStream oos)`
`void`	`setFFIHandle(RubyBasicObject self, java.lang.Object value)` Set the FFI handle for the given object.
`void`	`setNativeHandle(RubyBasicObject self, java.lang.Object value)` Set the C ext handle for the given object.
`private static void`	`setObjectId(RubyClass realClass, RubyBasicObject self, int index, long value)` Update object_id with the given value.
`void`	`setVariableInternal(RubyBasicObject self, int index, java.lang.Object value)` Virtual entry point for setting a variable into an object.
`static void`	`setVariableInternal(RubyClass realClass, RubyBasicObject self, int index, java.lang.Object value)` Static entry point for setting a variable in an object.
`void`	`syncVariables(RubyBasicObject self, IRubyObject other)` Sync one this object's variables with other's - this is used to make rbClone work correctly.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - realClass
```
private final RubyClass realClass
```
    the "real" class associated with this table
  - EMPTY_STRING_ARRAY
```
private static java.lang.String[] EMPTY_STRING_ARRAY
```
    an empty array of String
  - variableAccessors
```
private java.util.Map<java.lang.String,VariableAccessor> variableAccessors
```
    a map from strings to accessors for this table
  - variableNames
```
private volatile java.lang.String[] variableNames
```
    an array of all registered variable names
  - hasObjectID
```
private volatile boolean hasObjectID
```
    whether a slot has been allocated to object_id
  - fieldVariables
```
private volatile int fieldVariables
```
    whether objects associated with this table use fields
  - objectIdVariableAccessorField
```
private final VariableAccessorField objectIdVariableAccessorField
```
    a lazy accessor for object_id
  - cextHandleVariableAccessorField
```
private final VariableAccessorField cextHandleVariableAccessorField
```
    a lazy accessor for C ext handle
  - ffiHandleVariableAccessorField
```
private final VariableAccessorField ffiHandleVariableAccessorField
```
    a lazy accessor for FFI handle
  - objectGroupVariableAccessorField
```
private final VariableAccessorField objectGroupVariableAccessorField
```
    a lazy accessor for object group
- Constructor Detail
  - VariableTableManager
```
public VariableTableManager(RubyClass realClass)
```
    Construct a new VariableTable Manager for the given "real" class.
    
    Parameters:
    
    realClass - the "real" class associated with this table
- Method Detail
  - getVariableAccessorsForRead
```
public java.util.Map<java.lang.String,VariableAccessor> getVariableAccessorsForRead()
```
    Get the map of all current variable accessors with intent to read from it.
    
    Returns:
    
    a map of current variable accessors
  - hasObjectID
```
public boolean hasObjectID()
```
    Whether this table has been used to allocate space for an object_id.
    
    Returns:
    
    true if object_id has been allocated; false otherwise
  - getObjectId
```
public long getObjectId(RubyBasicObject self)
```
    Get the object_id from a given RubyBasicObject, possibly allocating space for it.
    
    Parameters:
    
    self - the object from which to get object_id
    
    Returns:
    
    the object's object_id (possibly new)
  - setVariableInternal
```
public void setVariableInternal(RubyBasicObject self,
                                int index,
                                java.lang.Object value)
```
    Virtual entry point for setting a variable into an object.
    
    Parameters:
    
    self - the object into which to set the value
    
    index - the index allocated for the value
    
    value - the value
  - setVariableInternal
```
public static void setVariableInternal(RubyClass realClass,
                                       RubyBasicObject self,
                                       int index,
                                       java.lang.Object value)
```
    Static entry point for setting a variable in an object.
    
    Parameters:
    
    realClass - the "real" class of the object
    
    self - the object into which to set the variable
    
    index - the index allocated for the variable
    
    value - the value of the variable
  - getVariableAccessorForWrite
```
public VariableAccessor getVariableAccessorForWrite(java.lang.String name)
```
    Get the variable accessor for the given name with intent to use it for writing.
    
    Parameters:
    
    name - the name of the variable
    
    Returns:
    
    an accessor appropriate for writing
  - getVariableAccessorForVar
```
public VariableAccessor getVariableAccessorForVar(java.lang.String name,
                                                  int index)
```
  - getVariableAccessorForRead
```
public VariableAccessor getVariableAccessorForRead(java.lang.String name)
```
    Get the variable accessor for the given name with intent to use it for reading.
    
    Parameters:
    
    name - the name of the variable
    
    Returns:
    
    an accessor appropriate for reading
  - getObjectIdAccessorField
```
public VariableAccessorField getObjectIdAccessorField()
```
    Retrieve the lazy accessor (VariableAccessorField) for object_id.
    
    Returns:
    
    the lazy accessor for object_id
  - getNativeHandleAccessorField
```
public VariableAccessorField getNativeHandleAccessorField()
```
    Retrieve the lazy accessor (VariableAccessorField) for C ext handle.
    
    Returns:
    
    the lazy accessor for C ext handle
  - getNativeHandleAccessorForRead
```
public VariableAccessor getNativeHandleAccessorForRead()
```
    Retrieve the read accessor for C ext handle.
    
    Returns:
    
    the read accessor for C ext handle
  - getNativeHandleAccessorForWrite
```
public VariableAccessor getNativeHandleAccessorForWrite()
```
    Retrieve the write accessor for C ext handle.
    
    Returns:
    
    the write accessor for C ext handle
  - getFFIHandleAccessorField
```
public VariableAccessorField getFFIHandleAccessorField()
```
    Retrieve the lazy accessor (VariableAccessorField) for FFI handle.
    
    Returns:
    
    the lazy accessor for FFI handle
  - getFFIHandleAccessorForRead
```
public VariableAccessor getFFIHandleAccessorForRead()
```
    Retrieve the read accessor for FFI handle.
    
    Returns:
    
    the read accessor for FFI handle
  - getFFIHandleAccessorForWrite
```
public VariableAccessor getFFIHandleAccessorForWrite()
```
    Retrieve the write accessor for FFI handle.
    
    Returns:
    
    the write accessor for FFI handle
  - getObjectGroupAccessorField
```
public VariableAccessorField getObjectGroupAccessorField()
```
    Retrieve the lazy accessor (VariableAccessorField) for object group.
    
    Returns:
    
    the lazy accessor for object group
  - getObjectGroupAccessorForRead
```
public VariableAccessor getObjectGroupAccessorForRead()
```
    Retrieve the read accessor for object group.
    
    Returns:
    
    the read accessor for object group
  - getObjectGroupAccessorForWrite
```
public VariableAccessor getObjectGroupAccessorForWrite()
```
    Retrieve the write accessor for object group.
    
    Returns:
    
    the write accessor for object group
  - getNativeHandle
```
public final java.lang.Object getNativeHandle(RubyBasicObject self)
```
    Retrieve the C ext handle for the given object.
    
    Parameters:
    
    self - the object
    
    Returns:
    
    the object's C ext handle
  - setNativeHandle
```
public final void setNativeHandle(RubyBasicObject self,
                                  java.lang.Object value)
```
    Set the C ext handle for the given object.
    
    Parameters:
    
    self - the object
    
    value - the object's C ext handle
  - getFFIHandle
```
public final java.lang.Object getFFIHandle(RubyBasicObject self)
```
    Retrieve the FFI ext handle for the given object.
    
    Parameters:
    
    self - the object
    
    Returns:
    
    the object's FFI handle
  - setFFIHandle
```
public final void setFFIHandle(RubyBasicObject self,
                               java.lang.Object value)
```
    Set the FFI handle for the given object.
    
    Parameters:
    
    self - the object
    
    self - the object's FFI handle
  - getVariableTableSize
```
public int getVariableTableSize()
```
    Get the size of the variable table, excluding extra vars (object_id, etc).
    
    Returns:
    
    the variable table's size, excluding extras
  - getVariableTableSizeWithExtras
```
public int getVariableTableSizeWithExtras()
```
    Get the size of the variable table, including extra vars (object_etc, etc).
    
    Returns:
  - getVariableTableCopy
```
public java.util.Map<java.lang.String,VariableAccessor> getVariableTableCopy()
```
    Get a Map representing all variables registered in the variable table.
    
    Returns:
    
    a map of names to accessors for all variables
  - getVariableNames
```
public java.lang.String[] getVariableNames()
```
    Get an array of all the known instance variable names. The offset into the array indicates the offset of the variable's value in the per-object variable array.
    
    Returns:
    
    a copy of the array of known instance variable names
  - syncVariables
```
public void syncVariables(RubyBasicObject self,
                          IRubyObject other)
```
    Sync one this object's variables with other's - this is used to make rbClone work correctly.
    
    Parameters:
    
    self - the object into which to sync variables
    
    other - the object from which to sync variables
  - hasVariables
```
public boolean hasVariables(RubyBasicObject object)
```
    Returns true if object has any variables, defined as:
    - instance variables
    - class variables
    - constants
    - internal variables, such as those used when marshaling Ranges and Exceptions
    Returns:
    
    true if object has any variables, else false
  - serializeVariables
```
public void serializeVariables(RubyBasicObject object,
                               java.io.ObjectOutputStream oos)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - deserializeVariables
```
public void deserializeVariables(RubyBasicObject object,
                                 java.io.ObjectInputStream ois)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException
```
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - clearVariable
```
public java.lang.Object clearVariable(RubyBasicObject object,
                                      java.lang.String name)
```
  - initObjectId
```
private long initObjectId(RubyBasicObject self,
                          VariableAccessor objectIdAccessor)
```
    We lazily stand up the object ID since it forces us to stand up per-object state for a given object. We also check for ObjectSpace here, and normally we do not register a given object ID into ObjectSpace due to the high cost associated with constructing the related weakref. Most uses of id/object_id will only ever need it to be a unique identifier, and the id2ref behavior provided by ObjectSpace is considered internal and not generally supported. Note that this method does not need to be synchronized, since it is only called from #getObjectId, which synchronizes against the target object. The accessor is already present, and variable accesses are thread-safe (albeit not atomic, which necessitates the synchronization in getObjectId). Synchronization here ends up being a bottleneck for every object created from the class that contains this VariableTableManager. See GH #1400.
    
    Parameters:
    
    objectIdAccessor - The variable accessor to use for storing the generated object ID
    
    Returns:
    
    The generated object ID
  - setObjectId
```
private static void setObjectId(RubyClass realClass,
                                RubyBasicObject self,
                                int index,
                                long value)
```
    Update object_id with the given value.
    
    Parameters:
    
    self - the object into which to set object_id
    
    index - the index allocated to store object_id
    
    value - the value of object_id
  - makeSyncedTable
```
private static java.lang.Object[] makeSyncedTable(java.lang.Object[] currentTable,
                                                  java.lang.Object[] otherTable,
                                                  int objectIdIdx)
```
    Make a new variable table based on the values in a current and other (incoming) table, excluding object_id at specified index.
    
    Parameters:
    
    currentTable - the current table
    
    otherTable - the other (incoming) table
    
    objectIdIdx - the index of object_id to exclude
    
    Returns:
    
    a new table formed by combining the given tables
  - allocateVariableAccessor
```
final VariableAccessor allocateVariableAccessor(java.lang.String name)
```
    Allocate a new VariableAccessor for the named variable.
    
    Parameters:
    
    name - the name of the variable
    
    Returns:
    
    the new VariableAccessor
  - allocateVariableAccessorForVar
```
final VariableAccessor allocateVariableAccessorForVar(java.lang.String name,
                                                      int index)
```

Class VariableTableManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

realClass

EMPTY_STRING_ARRAY

variableAccessors

variableNames

hasObjectID

fieldVariables

objectIdVariableAccessorField

cextHandleVariableAccessorField

ffiHandleVariableAccessorField

objectGroupVariableAccessorField

Constructor Detail

VariableTableManager

Method Detail

getVariableAccessorsForRead

hasObjectID

getObjectId

setVariableInternal

setVariableInternal

getVariableAccessorForWrite

getVariableAccessorForVar

getVariableAccessorForRead

getObjectIdAccessorField

getNativeHandleAccessorField

getNativeHandleAccessorForRead

getNativeHandleAccessorForWrite

getFFIHandleAccessorField

getFFIHandleAccessorForRead

getFFIHandleAccessorForWrite

getObjectGroupAccessorField

getObjectGroupAccessorForRead

getObjectGroupAccessorForWrite

getNativeHandle

setNativeHandle

getFFIHandle

setFFIHandle

getVariableTableSize

getVariableTableSizeWithExtras

getVariableTableCopy

getVariableNames

syncVariables

hasVariables

serializeVariables

deserializeVariables

clearVariable

initObjectId

setObjectId

makeSyncedTable

allocateVariableAccessor

allocateVariableAccessorForVar