WeakArr.st
author claus
Thu, 02 Jun 1994 18:22:49 +0200
changeset 88 81dacba7a63a
parent 44 b262907c93ea
child 95 d22739a0c6e9
permissions -rw-r--r--
*** empty log message ***
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
     1
"
62211a9bc04d Initial revision
claus
parents:
diff changeset
     2
 COPYRIGHT (c) 1991 by Claus Gittinger
62211a9bc04d Initial revision
claus
parents:
diff changeset
     3
              All Rights Reserved
62211a9bc04d Initial revision
claus
parents:
diff changeset
     4
62211a9bc04d Initial revision
claus
parents:
diff changeset
     5
 This software is furnished under a license and may be used
62211a9bc04d Initial revision
claus
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
62211a9bc04d Initial revision
claus
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
62211a9bc04d Initial revision
claus
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
62211a9bc04d Initial revision
claus
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
62211a9bc04d Initial revision
claus
parents:
diff changeset
    10
 hereby transferred.
62211a9bc04d Initial revision
claus
parents:
diff changeset
    11
"
62211a9bc04d Initial revision
claus
parents:
diff changeset
    12
62211a9bc04d Initial revision
claus
parents:
diff changeset
    13
Array variableSubclass:#WeakArray
62211a9bc04d Initial revision
claus
parents:
diff changeset
    14
       instanceVariableNames:'watcher dependents'
62211a9bc04d Initial revision
claus
parents:
diff changeset
    15
       classVariableNames:''
62211a9bc04d Initial revision
claus
parents:
diff changeset
    16
       poolDictionaries:''
62211a9bc04d Initial revision
claus
parents:
diff changeset
    17
       category:'System-Support'
62211a9bc04d Initial revision
claus
parents:
diff changeset
    18
!
62211a9bc04d Initial revision
claus
parents:
diff changeset
    19
62211a9bc04d Initial revision
claus
parents:
diff changeset
    20
WeakArray comment:'
62211a9bc04d Initial revision
claus
parents:
diff changeset
    21
COPYRIGHT (c) 1991 by Claus Gittinger
62211a9bc04d Initial revision
claus
parents:
diff changeset
    22
              All Rights Reserved
62211a9bc04d Initial revision
claus
parents:
diff changeset
    23
'!
62211a9bc04d Initial revision
claus
parents:
diff changeset
    24
62211a9bc04d Initial revision
claus
parents:
diff changeset
    25
!WeakArray class methodsFor:'documentation'!
62211a9bc04d Initial revision
claus
parents:
diff changeset
    26
88
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    27
copyright
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    28
"
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    29
 COPYRIGHT (c) 1991 by Claus Gittinger
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    30
              All Rights Reserved
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    31
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    32
 This software is furnished under a license and may be used
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    33
 only in accordance with the terms of that license and with the
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    34
 inclusion of the above copyright notice.   This software may not
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    35
 be provided or otherwise made available to, or used by, any
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    36
 other person.  No title to or ownership of the software is
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    37
 hereby transferred.
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    38
"
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    39
!
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    40
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    41
version
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    42
"
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    43
$Header: /cvs/stx/stx/libbasic/Attic/WeakArr.st,v 1.4 1994-06-02 16:22:45 claus Exp $
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    44
"
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    45
!
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    46
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
    47
documentation
62211a9bc04d Initial revision
claus
parents:
diff changeset
    48
"
88
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    49
    WeakArrays can be used to trace disposal of objects; in contrast to other
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    50
    objects, references by WeakArrays will NOT keep an object from dying.
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    51
    Instead, whenever an object kept in a WeakArray dies, its entry is nilled,
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    52
    and the WeakArray informed by the storage manager. 
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    53
    This is done by sending a #disposeInterrupt to the weakArray.
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    54
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    55
    This interrupt is cought here and informs the watcher and, if there is
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    56
    a dependent, this one gets informed as well (I dont know, which of the
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    57
    two mechanisms will survive in the long run - I started with the watcher,
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    58
    but now switch to dependencies since they seem to provide more flexibility).
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    59
    Therefore, be prepared, that the watcher mechanism will vanish in the 
81dacba7a63a *** empty log message ***
claus
parents: 44
diff changeset
    60
    future.
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
    61
"
62211a9bc04d Initial revision
claus
parents:
diff changeset
    62
! !
62211a9bc04d Initial revision
claus
parents:
diff changeset
    63
62211a9bc04d Initial revision
claus
parents:
diff changeset
    64
!WeakArray class methodsFor:'instance creation'!
62211a9bc04d Initial revision
claus
parents:
diff changeset
    65
62211a9bc04d Initial revision
claus
parents:
diff changeset
    66
new:size
44
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    67
    "return a new weakArray with size slots.
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    68
     This is a kludge: would like to set WEAK-flag in class
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
    69
     initialize method, but no order of class-init is defined ...
62211a9bc04d Initial revision
claus
parents:
diff changeset
    70
     (therefore it could happen, that a WeakArray is used by other
62211a9bc04d Initial revision
claus
parents:
diff changeset
    71
      class inits before this init is evaluated. To avoid this,
44
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    72
      the WEAK bit in the class is set when the first WeakArray is 
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    73
      created)"
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
    74
44
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    75
    |newArray|
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    76
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    77
    self flags:5.   "having a constant 5 here is very bad"
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
    78
    ObjectMemory disposeInterruptHandler:self.
62211a9bc04d Initial revision
claus
parents:
diff changeset
    79
    newArray := self basicNew:size.
62211a9bc04d Initial revision
claus
parents:
diff changeset
    80
%{
62211a9bc04d Initial revision
claus
parents:
diff changeset
    81
    OBJ ok;
62211a9bc04d Initial revision
claus
parents:
diff changeset
    82
    OBJ __addShadowObject();
62211a9bc04d Initial revision
claus
parents:
diff changeset
    83
62211a9bc04d Initial revision
claus
parents:
diff changeset
    84
    ok = __addShadowObject(newArray, 0);
62211a9bc04d Initial revision
claus
parents:
diff changeset
    85
    if (ok == false) {
44
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    86
        /* 
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    87
         * this happens when too many shadow objects are
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    88
         * already there, collect garbage to get rid of
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
    89
         * obsolete ones, and try again.
44
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    90
         * since a full collect is expensive, we try
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    91
         * a scavenge first, doing a full collect only if 
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    92
         * that does not help.
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    93
         */
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    94
        nonTenuringScavenge(__context);
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    95
        ok = __addShadowObject(newArray, 0);
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    96
        if (ok == false) {
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    97
            /* try more ... */
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    98
            scavenge(__context);
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
    99
            ok = __addShadowObject(newArray, 0);
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   100
            if (ok == false) {
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   101
                /* hard stuff - need full collect */
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   102
                __garbageCollect(__context);
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   103
                ok = __addShadowObject(newArray, 0);
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   104
                if (ok == false) {
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   105
                    /* mhmh - it seems that there are really many shadow 
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   106
                       objects around - force creation */
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   107
                    ok = __addShadowObject(newArray, 1);
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   108
                    if (ok == false) {
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   109
                        /* no chance - something must be wrong */
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   110
                        newArray = nil;
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   111
                    }
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   112
                }
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   113
            }
b262907c93ea *** empty log message ***
claus
parents: 10
diff changeset
   114
        }
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
   115
    }
62211a9bc04d Initial revision
claus
parents:
diff changeset
   116
%}
62211a9bc04d Initial revision
claus
parents:
diff changeset
   117
.
62211a9bc04d Initial revision
claus
parents:
diff changeset
   118
    ^ newArray
62211a9bc04d Initial revision
claus
parents:
diff changeset
   119
! !
62211a9bc04d Initial revision
claus
parents:
diff changeset
   120
62211a9bc04d Initial revision
claus
parents:
diff changeset
   121
!WeakArray class methodsFor:'dispose handling'!
62211a9bc04d Initial revision
claus
parents:
diff changeset
   122
62211a9bc04d Initial revision
claus
parents:
diff changeset
   123
allShadowObjectsDo:aBlock
62211a9bc04d Initial revision
claus
parents:
diff changeset
   124
    "evaluate the argument, aBlock for all known shadow objects"
62211a9bc04d Initial revision
claus
parents:
diff changeset
   125
%{
62211a9bc04d Initial revision
claus
parents:
diff changeset
   126
    __allShadowObjectsDo(&aBlock, __context);
62211a9bc04d Initial revision
claus
parents:
diff changeset
   127
%}
62211a9bc04d Initial revision
claus
parents:
diff changeset
   128
!
62211a9bc04d Initial revision
claus
parents:
diff changeset
   129
62211a9bc04d Initial revision
claus
parents:
diff changeset
   130
allChangedShadowObjectsDo:aBlock
62211a9bc04d Initial revision
claus
parents:
diff changeset
   131
    "evaluate the argument, aBlock for all known shadow objects which have
62211a9bc04d Initial revision
claus
parents:
diff changeset
   132
     lost a pointer recently."
62211a9bc04d Initial revision
claus
parents:
diff changeset
   133
%{
62211a9bc04d Initial revision
claus
parents:
diff changeset
   134
    __allChangedShadowObjectsDo(&aBlock, __context);
62211a9bc04d Initial revision
claus
parents:
diff changeset
   135
%}
62211a9bc04d Initial revision
claus
parents:
diff changeset
   136
!
62211a9bc04d Initial revision
claus
parents:
diff changeset
   137
62211a9bc04d Initial revision
claus
parents:
diff changeset
   138
disposeInterrupt
62211a9bc04d Initial revision
claus
parents:
diff changeset
   139
    "this is triggered by the garbage collector,
62211a9bc04d Initial revision
claus
parents:
diff changeset
   140
     whenever any shadowArray looses a pointer."
62211a9bc04d Initial revision
claus
parents:
diff changeset
   141
62211a9bc04d Initial revision
claus
parents:
diff changeset
   142
    self allChangedShadowObjectsDo:[:aShadowArray | 
62211a9bc04d Initial revision
claus
parents:
diff changeset
   143
        aShadowArray changed.
62211a9bc04d Initial revision
claus
parents:
diff changeset
   144
        aShadowArray watcher notNil ifTrue:[
62211a9bc04d Initial revision
claus
parents:
diff changeset
   145
            aShadowArray watcher informDispose
62211a9bc04d Initial revision
claus
parents:
diff changeset
   146
        ]
62211a9bc04d Initial revision
claus
parents:
diff changeset
   147
    ]
62211a9bc04d Initial revision
claus
parents:
diff changeset
   148
! !
62211a9bc04d Initial revision
claus
parents:
diff changeset
   149
62211a9bc04d Initial revision
claus
parents:
diff changeset
   150
!WeakArray methodsFor:'accessing'!
62211a9bc04d Initial revision
claus
parents:
diff changeset
   151
62211a9bc04d Initial revision
claus
parents:
diff changeset
   152
dependents 
10
claus
parents: 6
diff changeset
   153
    "return the dependents of the receiver"
claus
parents: 6
diff changeset
   154
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
   155
    ^ dependents
62211a9bc04d Initial revision
claus
parents:
diff changeset
   156
!
62211a9bc04d Initial revision
claus
parents:
diff changeset
   157
62211a9bc04d Initial revision
claus
parents:
diff changeset
   158
dependents:aCollection
10
claus
parents: 6
diff changeset
   159
    "set the dependents of the receiver"
claus
parents: 6
diff changeset
   160
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
   161
    dependents := aCollection
62211a9bc04d Initial revision
claus
parents:
diff changeset
   162
!
62211a9bc04d Initial revision
claus
parents:
diff changeset
   163
62211a9bc04d Initial revision
claus
parents:
diff changeset
   164
watcher
10
claus
parents: 6
diff changeset
   165
    "return the watcher of the receiver.
claus
parents: 6
diff changeset
   166
     The watcher-stuff is a leftover from an old implementation 
claus
parents: 6
diff changeset
   167
     and will vanish soon"
claus
parents: 6
diff changeset
   168
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
   169
    ^ watcher
62211a9bc04d Initial revision
claus
parents:
diff changeset
   170
!
62211a9bc04d Initial revision
claus
parents:
diff changeset
   171
62211a9bc04d Initial revision
claus
parents:
diff changeset
   172
watcher:anObject
10
claus
parents: 6
diff changeset
   173
    "set the watcher of the receiver.
claus
parents: 6
diff changeset
   174
     The watcher-stuff is a leftover from an old implementation 
claus
parents: 6
diff changeset
   175
     and will vanish soon"
claus
parents: 6
diff changeset
   176
6
62211a9bc04d Initial revision
claus
parents:
diff changeset
   177
    watcher := anObject
62211a9bc04d Initial revision
claus
parents:
diff changeset
   178
! !