|
Class: WeakIdentityDictionary
Object
|
+--Collection
|
+--Set
|
+--Dictionary
|
+--IdentityDictionary
|
+--WeakIdentityDictionary
|
+--Registry
|
+--WeakDependencyDictionary
- Package:
- stx:libbasic
- Category:
- Collections-Weak
- Version:
- rev:
1.58
date: 2019/06/06 21:26:13
- user: cg
- file: WeakIdentityDictionary.st directory: libbasic
- module: stx stc-classLibrary: libbasic
- Author:
- Claus Gittinger
WeakIdentityDictionaries behave like IdentityDictionaries,
as long as the keys are still referenced by some
other (non-weak) object.
However, once the last non-weak reference ceases to exist,
the object will be automatically removed from the Weakcollection
(with some delay: it will be removed after the next garbage collect).
This class was added to support keeping track of dependents without
keeping the values alive - values simply become nil when no one else
references it. The original dependency mechanism used a regular Dictionary,
which usually leads to a lot of garbage being kept due to a forgotten
release. Using a WeakDictionary may be incompatible to ST-80 but is much
more comfortable, since no manual release of dependents is needed.
If you use this, be very careful since the collections size changes
'magically' - for example, testing for being nonEmpty and then
removing the first element may fail, since the element may vanish inbetween.
In general, never trust the value as returned by the size/isEmpty messages.
WeakArray
WeakValueDictionary
WeakIdentitySet
accessing
-
keys
-
return a collection containing all valid keys of the receiver
adding & removing
-
at: key ifAbsent: exceptionBlock
-
redefined to block interrupts
(avoid change of the dictionary while accessing)
-
at: key ifAbsentPut: replacementBlock
-
redefined to block interrupts
(avoid change of the dictionary while accessing)
-
at: key put: anObject
-
add the argument anObject under key, aKey to the receiver.
Return anObject (sigh).
Redefined to block interrupts, to avoid trouble when dependencies
are added within interrupting high prio processes.
-
removeKey: aKey ifAbsent: aBlock
-
remove the association under aKey from the collection,
return the value previously stored there.
If it was not in the collection return the result
from evaluating aBlock.
Redefined to avoid synchronization problems, in case
of interrupts (otherwise, there could be some other operation
on the receiver done by another process, which garbles my contents).
-
safeRemoveKey: key
-
redefined to block interrupts
(avoid change of the dictionary while accessing)
element disposal
-
clearDeadSlots
-
have to block here - dispose may be done at a low priority
from the background finalizer. If new items are added by a
higher prio process, the dictionary might get corrupted otherwise
-
update: something with: aParameter from: changedObject
-
an element (either key or value) died - clear out slots for
disposed keys.
enumerating
-
keysDo: aBlock
-
evaluate aBlock for each registered object
private
-
findKeyOrNil: key
-
Look for the key in the receiver.
If it is found, return the index,
otherwise the index of the first unused slot.
Grow the receiver, if key was not found, and no unused slots were present.
Warning: an empty slot MUST be filled by the sender - it is only to be sent
by at:put: / add: - like methods.
-
findKeyOrNilOrDeletedEntry: key
-
Look for the key in the receiver.
If it is found, return the index,
otherwise the index of the first unused slot.
Grow the receiver, if key was not found, and no unused slots were present.
-
grow: newSize
-
grow the receiver.
Redefined to block interrupts, to avoid trouble when dependencies
are added within interrupting high prio processes.
usage example(s):
-
initializeForCapacity: minSize
-
reset the receiver's contents.
Redefined to block interrupts, to avoid trouble when dependencies
are added within interrupting high prio processes.
-
keyContainerOfSize: n
-
return a container for keys of size n.
use WeakArrays here.
-
rehash
-
grow the receiver.
Redefined to block interrupts, to avoid trouble when dependencies
are added within interrupting high prio processes.
usage example(s):
queries
-
includes: anObject
-
redefined to block interrupts
(avoid change of the dictionary while accessing)
-
includesKey: key
-
redefined to block interrupts
(avoid change of the dictionary while accessing)
testing
-
isWeakCollection
-
return true, if the receiver has weak references to its elements.
|