WeakValueDictionary.st
author Claus Gittinger <cg@exept.de>
Wed, 29 Jan 1997 15:29:04 +0100
changeset 2303 f19df2d4c238
parent 2260 96d898c2874d
child 2307 54503a6dbb71
permissions -rw-r--r--
avoid creation of a blocks if possible - if not, cheap ones are now created
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     1
"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     2
 COPYRIGHT (c) 1992 by Claus Gittinger
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     3
	      All Rights Reserved
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     4
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     5
 This software is furnished under a license and may be used
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    10
 hereby transferred.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    11
"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    12
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    13
Dictionary subclass:#WeakValueDictionary
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    14
	instanceVariableNames:''
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    15
	classVariableNames:''
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    16
	poolDictionaries:''
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    17
	category:'Collections-Unordered'
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    18
!
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    19
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    20
!WeakValueDictionary class methodsFor:'documentation'!
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    21
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    22
copyright
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    23
"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    24
 COPYRIGHT (c) 1992 by Claus Gittinger
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    25
	      All Rights Reserved
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    26
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    27
 This software is furnished under a license and may be used
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    28
 only in accordance with the terms of that license and with the
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    29
 inclusion of the above copyright notice.   This software may not
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    30
 be provided or otherwise made available to, or used by, any
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    31
 other person.  No title to or ownership of the software is
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    32
 hereby transferred.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    33
"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    34
!
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    35
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    36
documentation
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    37
"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    38
    WeakValueDictionaries behave like Dictionaries, 
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    39
    as long as the values are still referenced by some 
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    40
    other (non-weak) object.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    41
    However, once the last non-weak reference ceases to exist,
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    42
    the Dictionary will return nil for the value at position key.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    43
    (with some delay: it will be removed after the next garbage collect).
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    44
2260
Claus Gittinger <cg@exept.de>
parents: 1790
diff changeset
    45
    If you use this, be very careful since the collections size changes
Claus Gittinger <cg@exept.de>
parents: 1790
diff changeset
    46
    'magically' - for example, testing for being nonEmpty and then
Claus Gittinger <cg@exept.de>
parents: 1790
diff changeset
    47
    removing the first element may fail, since the element may vanish inbetween.
Claus Gittinger <cg@exept.de>
parents: 1790
diff changeset
    48
    In general, never trust the value as returned by the size/isEmpty messages.
Claus Gittinger <cg@exept.de>
parents: 1790
diff changeset
    49
Claus Gittinger <cg@exept.de>
parents: 1790
diff changeset
    50
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    51
    [author:]
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    52
        Stefan Vogel
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    53
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    54
    [See also:]
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    55
        WeakArray WeakIdentityDictionary WeakIdentitySet
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    56
"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    57
! !
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    58
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    59
!WeakValueDictionary methodsFor:'adding & removing'!
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    60
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    61
at:key put:anObject
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    62
    "add the argument anObject under key, aKey to the receiver.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    63
     Return anObject (sigh).
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    64
     Redefined to block interrupts, to avoid trouble when dependencies
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    65
     are added within interrupting high prio processes."
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    66
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    67
    |ret|
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    68
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    69
    (OperatingSystem blockInterrupts) ifTrue:[
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    70
        "/ already blocked
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    71
        ^ super at:key put:anObject
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    72
    ].
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    73
1790
4187e9fc7357 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 1361
diff changeset
    74
    [
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    75
        ret := super at:key put:anObject.
1790
4187e9fc7357 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 1361
diff changeset
    76
    ] valueNowOrOnUnwindDo:[
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    77
        OperatingSystem unblockInterrupts
1790
4187e9fc7357 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 1361
diff changeset
    78
    ].
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    79
    ^ ret
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    80
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    81
    "Modified: 6.5.1996 / 12:22:26 / stefan"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    82
    "Created: 6.5.1996 / 14:47:37 / stefan"
1790
4187e9fc7357 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 1361
diff changeset
    83
    "Modified: 20.10.1996 / 14:05:04 / cg"
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    84
!
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    85
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    86
removeKey:aKey ifAbsent:aBlock
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    87
    "remove the association under aKey from the collection,
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    88
     return the value previously stored there..
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    89
     If it was not in the collection return the result 
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    90
     from evaluating aBlock.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    91
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    92
    Redefined to avoid synchronization problems, in case
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    93
    of interrupts (otherwise, there could be some other operation 
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    94
    on the receiver done by another process, which garbles my contents)."
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    95
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    96
    |ret|
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    97
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    98
    (OperatingSystem blockInterrupts) ifTrue:[
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
    99
        "/ already blocked
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   100
        ^ super removeKey:aKey ifAbsent:aBlock
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   101
    ].
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   102
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   103
    [
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   104
        ret := super removeKey:aKey ifAbsent:aBlock
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   105
    ] valueNowOrOnUnwindDo:[
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   106
        OperatingSystem unblockInterrupts
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   107
    ].
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   108
    ^ ret
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   109
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   110
    "Modified: 6.5.1996 / 12:44:07 / stefan"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   111
    "Created: 6.5.1996 / 14:47:37 / stefan"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   112
!
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   113
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   114
removeValue:aKey ifAbsent:aBlock
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   115
    "remove the association under aValue from the collection,
1351
ffc670d8edde Fix comment.
Stefan Vogel <sv@exept.de>
parents: 1341
diff changeset
   116
     return the key previously stored there..
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   117
     If it was not in the collection return the result 
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   118
     from evaluating aBlock.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   119
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   120
    Redefined to avoid synchronization problems, in case
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   121
    of interrupts (otherwise, there could be some other operation 
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   122
    on the receiver done by another process, which garbles my contents)."
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   123
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   124
    |ret|
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   125
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   126
    (OperatingSystem blockInterrupts) ifTrue:[
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   127
        "/ already blocked
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   128
        ^ super removeValue:aKey ifAbsent:aBlock
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   129
    ].
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   130
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   131
    [
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   132
        ret := super removeValue:aKey ifAbsent:aBlock
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   133
    ] valueNowOrOnUnwindDo:[
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   134
        OperatingSystem unblockInterrupts
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   135
    ].
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   136
    ^ ret.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   137
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   138
    "Created: 6.5.1996 / 14:47:37 / stefan"
1351
ffc670d8edde Fix comment.
Stefan Vogel <sv@exept.de>
parents: 1341
diff changeset
   139
    "Modified: 8.5.1996 / 14:54:09 / stefan"
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   140
! !
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   141
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   142
!WeakValueDictionary methodsFor:'private'!
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   143
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   144
valueContainerOfSize:n
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   145
    "return a container for values of size n.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   146
     use WeakArrays here."
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   147
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   148
    ^ WeakArray new:n.
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   149
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   150
    "Created: 6.5.1996 / 14:47:37 / stefan"
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   151
! !
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   152
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   153
!WeakValueDictionary class methodsFor:'documentation'!
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   154
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   155
version
2303
f19df2d4c238 avoid creation of a blocks if possible - if not, cheap ones are now created
Claus Gittinger <cg@exept.de>
parents: 2260
diff changeset
   156
    ^ '$Header: /cvs/stx/stx/libbasic/WeakValueDictionary.st,v 1.6 1997-01-29 14:29:04 cg Exp $'
1341
e28a1e49f252 First Version.
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   157
! !