Registry.st
author claus
Mon, 08 Nov 1993 03:32:43 +0100
changeset 10 4f1f9a91e406
parent 3 24d81bf47225
child 60 0cc690b50dff
permissions -rw-r--r--
2.8.1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
     1
"
a27a279701f8 Initial revision
claus
parents:
diff changeset
     2
 COPYRIGHT (c) 1993 by Claus Gittinger
a27a279701f8 Initial revision
claus
parents:
diff changeset
     3
              All Rights Reserved
a27a279701f8 Initial revision
claus
parents:
diff changeset
     4
a27a279701f8 Initial revision
claus
parents:
diff changeset
     5
 This software is furnished under a license and may be used
a27a279701f8 Initial revision
claus
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
a27a279701f8 Initial revision
claus
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
a27a279701f8 Initial revision
claus
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
a27a279701f8 Initial revision
claus
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
a27a279701f8 Initial revision
claus
parents:
diff changeset
    10
 hereby transferred.
a27a279701f8 Initial revision
claus
parents:
diff changeset
    11
"
a27a279701f8 Initial revision
claus
parents:
diff changeset
    12
a27a279701f8 Initial revision
claus
parents:
diff changeset
    13
Object subclass:#Registry
10
claus
parents: 3
diff changeset
    14
       instanceVariableNames:'registeredObjects phantoms cleanState'
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
    15
       classVariableNames:''
a27a279701f8 Initial revision
claus
parents:
diff changeset
    16
       poolDictionaries:''
a27a279701f8 Initial revision
claus
parents:
diff changeset
    17
       category:'System-Support'
a27a279701f8 Initial revision
claus
parents:
diff changeset
    18
!
a27a279701f8 Initial revision
claus
parents:
diff changeset
    19
a27a279701f8 Initial revision
claus
parents:
diff changeset
    20
Registry comment:'
a27a279701f8 Initial revision
claus
parents:
diff changeset
    21
a27a279701f8 Initial revision
claus
parents:
diff changeset
    22
COPYRIGHT (c) 1993 by Claus Gittinger
a27a279701f8 Initial revision
claus
parents:
diff changeset
    23
              All Rights Reserved
a27a279701f8 Initial revision
claus
parents:
diff changeset
    24
10
claus
parents: 3
diff changeset
    25
$Header: /cvs/stx/stx/libbasic/Registry.st,v 1.4 1993-11-08 02:31:48 claus Exp $
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
    26
written jun 93 by claus
a27a279701f8 Initial revision
claus
parents:
diff changeset
    27
'!
a27a279701f8 Initial revision
claus
parents:
diff changeset
    28
a27a279701f8 Initial revision
claus
parents:
diff changeset
    29
!Registry class methodsFor:'documentation'!
a27a279701f8 Initial revision
claus
parents:
diff changeset
    30
a27a279701f8 Initial revision
claus
parents:
diff changeset
    31
documentation
a27a279701f8 Initial revision
claus
parents:
diff changeset
    32
"
10
claus
parents: 3
diff changeset
    33
Registries provide an easy interface to using WeakArrays. 
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
    34
A class, which wants to be informed of instance-death, can put a created object
a27a279701f8 Initial revision
claus
parents:
diff changeset
    35
into a registry. The registry will create a copy of the object, and
a27a279701f8 Initial revision
claus
parents:
diff changeset
    36
watch out for death of the registered object. When it dies, the copy will
a27a279701f8 Initial revision
claus
parents:
diff changeset
    37
be sent the message >>disposed.
a27a279701f8 Initial revision
claus
parents:
diff changeset
    38
The trick with the shallow copy is especially nice, you can think of it as
a27a279701f8 Initial revision
claus
parents:
diff changeset
    39
beeing the original object which died.
a27a279701f8 Initial revision
claus
parents:
diff changeset
    40
a27a279701f8 Initial revision
claus
parents:
diff changeset
    41
All objects, which keep external resources (such as fileDescriptors, fonts, 
a27a279701f8 Initial revision
claus
parents:
diff changeset
    42
colormap-entries etc.) should be registered, so that the underlying resource
a27a279701f8 Initial revision
claus
parents:
diff changeset
    43
can be freed when the object goes away.
a27a279701f8 Initial revision
claus
parents:
diff changeset
    44
a27a279701f8 Initial revision
claus
parents:
diff changeset
    45
Of course, you too can use it to do whatever you need to do in case of the
a27a279701f8 Initial revision
claus
parents:
diff changeset
    46
death of an object.
a27a279701f8 Initial revision
claus
parents:
diff changeset
    47
"
a27a279701f8 Initial revision
claus
parents:
diff changeset
    48
! !
a27a279701f8 Initial revision
claus
parents:
diff changeset
    49
a27a279701f8 Initial revision
claus
parents:
diff changeset
    50
!Registry methodsFor:'dispose handling'!
a27a279701f8 Initial revision
claus
parents:
diff changeset
    51
a27a279701f8 Initial revision
claus
parents:
diff changeset
    52
informDispose
a27a279701f8 Initial revision
claus
parents:
diff changeset
    53
    "an instance has been destroyed - look which one it was"
a27a279701f8 Initial revision
claus
parents:
diff changeset
    54
a27a279701f8 Initial revision
claus
parents:
diff changeset
    55
    |phantom|
a27a279701f8 Initial revision
claus
parents:
diff changeset
    56
10
claus
parents: 3
diff changeset
    57
    cleanState ifTrue:[
claus
parents: 3
diff changeset
    58
        1 to:phantoms size do:[:index |
claus
parents: 3
diff changeset
    59
            (registeredObjects at:index) isNil ifTrue:[
claus
parents: 3
diff changeset
    60
                phantom := phantoms at:index.
claus
parents: 3
diff changeset
    61
                phantom notNil ifTrue:[
claus
parents: 3
diff changeset
    62
                    phantoms at:index put:nil.
claus
parents: 3
diff changeset
    63
                    phantom disposed
claus
parents: 3
diff changeset
    64
                ]
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
    65
            ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
    66
        ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
    67
    ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
    68
! !
a27a279701f8 Initial revision
claus
parents:
diff changeset
    69
a27a279701f8 Initial revision
claus
parents:
diff changeset
    70
!Registry methodsFor:'enumeration'!
a27a279701f8 Initial revision
claus
parents:
diff changeset
    71
a27a279701f8 Initial revision
claus
parents:
diff changeset
    72
contentsDo:aBlock
a27a279701f8 Initial revision
claus
parents:
diff changeset
    73
    "evaluate aBlock for each registered object"
a27a279701f8 Initial revision
claus
parents:
diff changeset
    74
a27a279701f8 Initial revision
claus
parents:
diff changeset
    75
    registeredObjects notNil ifTrue:[
a27a279701f8 Initial revision
claus
parents:
diff changeset
    76
        registeredObjects do:[:o |
a27a279701f8 Initial revision
claus
parents:
diff changeset
    77
            o notNil ifTrue:[
a27a279701f8 Initial revision
claus
parents:
diff changeset
    78
                aBlock value:o
a27a279701f8 Initial revision
claus
parents:
diff changeset
    79
            ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
    80
        ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
    81
    ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
    82
! !
a27a279701f8 Initial revision
claus
parents:
diff changeset
    83
a27a279701f8 Initial revision
claus
parents:
diff changeset
    84
!Registry methodsFor:'accessing'!
a27a279701f8 Initial revision
claus
parents:
diff changeset
    85
a27a279701f8 Initial revision
claus
parents:
diff changeset
    86
contents
a27a279701f8 Initial revision
claus
parents:
diff changeset
    87
    "return the collection of registered objects"
a27a279701f8 Initial revision
claus
parents:
diff changeset
    88
a27a279701f8 Initial revision
claus
parents:
diff changeset
    89
    ^ registeredObjects
a27a279701f8 Initial revision
claus
parents:
diff changeset
    90
!
a27a279701f8 Initial revision
claus
parents:
diff changeset
    91
a27a279701f8 Initial revision
claus
parents:
diff changeset
    92
changed:anObject
a27a279701f8 Initial revision
claus
parents:
diff changeset
    93
    "a registered object has changed, create a new phantom"
a27a279701f8 Initial revision
claus
parents:
diff changeset
    94
a27a279701f8 Initial revision
claus
parents:
diff changeset
    95
    |index|
a27a279701f8 Initial revision
claus
parents:
diff changeset
    96
a27a279701f8 Initial revision
claus
parents:
diff changeset
    97
    index := registeredObjects identityIndexOf:anObject ifAbsent:[0].
a27a279701f8 Initial revision
claus
parents:
diff changeset
    98
    index ~~ 0 ifTrue:[
a27a279701f8 Initial revision
claus
parents:
diff changeset
    99
        phantoms at:index put:anObject shallowCopy.
a27a279701f8 Initial revision
claus
parents:
diff changeset
   100
    ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
   101
!
a27a279701f8 Initial revision
claus
parents:
diff changeset
   102
a27a279701f8 Initial revision
claus
parents:
diff changeset
   103
register:anObject
a27a279701f8 Initial revision
claus
parents:
diff changeset
   104
    "register anObject, so that a copy of it gets the disposed message
2
claus
parents: 1
diff changeset
   105
     when anObject dies (some time in the future)"
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   106
2
claus
parents: 1
diff changeset
   107
    |phantom newColl newPhantoms
claus
parents: 1
diff changeset
   108
     count "{ Class: SmallInteger }"
claus
parents: 1
diff changeset
   109
     p index|
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   110
a27a279701f8 Initial revision
claus
parents:
diff changeset
   111
    phantom := anObject shallowCopy.
a27a279701f8 Initial revision
claus
parents:
diff changeset
   112
a27a279701f8 Initial revision
claus
parents:
diff changeset
   113
    registeredObjects isNil ifTrue:[
10
claus
parents: 3
diff changeset
   114
        registeredObjects := WeakArray new:10.
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   115
        registeredObjects watcher:self.
a27a279701f8 Initial revision
claus
parents:
diff changeset
   116
        registeredObjects at:1 put:anObject.
2
claus
parents: 1
diff changeset
   117
        phantoms := Array new:10.
claus
parents: 1
diff changeset
   118
	phantoms at:1 put:phantom.
10
claus
parents: 3
diff changeset
   119
	cleanState := true.
2
claus
parents: 1
diff changeset
   120
	ObjectMemory addDependent:self.
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   121
        ^ self
a27a279701f8 Initial revision
claus
parents:
diff changeset
   122
    ].
a27a279701f8 Initial revision
claus
parents:
diff changeset
   123
a27a279701f8 Initial revision
claus
parents:
diff changeset
   124
    index := registeredObjects identityIndexOf:anObject ifAbsent:[0].
a27a279701f8 Initial revision
claus
parents:
diff changeset
   125
    index ~~ 0 ifTrue:[
2
claus
parents: 1
diff changeset
   126
	"already registered"
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   127
	phantoms at:index put:phantom.
2
claus
parents: 1
diff changeset
   128
	self error:'object is already registered'.
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   129
	^ self
a27a279701f8 Initial revision
claus
parents:
diff changeset
   130
    ].
a27a279701f8 Initial revision
claus
parents:
diff changeset
   131
a27a279701f8 Initial revision
claus
parents:
diff changeset
   132
    "search for a free slot, on the fly look for leftovers"
a27a279701f8 Initial revision
claus
parents:
diff changeset
   133
    count := phantoms size.
a27a279701f8 Initial revision
claus
parents:
diff changeset
   134
    1 to:count do:[:index |
a27a279701f8 Initial revision
claus
parents:
diff changeset
   135
        (registeredObjects at:index) isNil ifTrue:[
a27a279701f8 Initial revision
claus
parents:
diff changeset
   136
            "is there a leftover ?"
2
claus
parents: 1
diff changeset
   137
            p := phantoms at:index.
claus
parents: 1
diff changeset
   138
            p notNil ifTrue:[
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   139
                phantoms at:index put:nil.
2
claus
parents: 1
diff changeset
   140
                p disposed.
claus
parents: 1
diff changeset
   141
		p := nil.
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   142
            ].
2
claus
parents: 1
diff changeset
   143
            registeredObjects at:index put:anObject.
claus
parents: 1
diff changeset
   144
            phantoms at:index put:phantom.
claus
parents: 1
diff changeset
   145
            ^ self
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   146
        ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
   147
    ].
a27a279701f8 Initial revision
claus
parents:
diff changeset
   148
a27a279701f8 Initial revision
claus
parents:
diff changeset
   149
    "no free slot, add at the end"
a27a279701f8 Initial revision
claus
parents:
diff changeset
   150
10
claus
parents: 3
diff changeset
   151
    newColl := WeakArray new:(count * 2).
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   152
    newColl replaceFrom:1 to:count with:registeredObjects.
a27a279701f8 Initial revision
claus
parents:
diff changeset
   153
    registeredObjects := newColl.
a27a279701f8 Initial revision
claus
parents:
diff changeset
   154
    registeredObjects watcher:self.
2
claus
parents: 1
diff changeset
   155
    registeredObjects at:(count + 1) put:anObject.
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   156
2
claus
parents: 1
diff changeset
   157
    newPhantoms := Array new:(count * 2).
claus
parents: 1
diff changeset
   158
    newPhantoms replaceFrom:1 to:count with:phantoms.
claus
parents: 1
diff changeset
   159
    phantoms := newPhantoms.
claus
parents: 1
diff changeset
   160
    phantoms at:(count + 1) put:phantom.
1
a27a279701f8 Initial revision
claus
parents:
diff changeset
   161
!
a27a279701f8 Initial revision
claus
parents:
diff changeset
   162
a27a279701f8 Initial revision
claus
parents:
diff changeset
   163
unregister:anObject
a27a279701f8 Initial revision
claus
parents:
diff changeset
   164
    "remove registration of anObject, without telling the phantom;
a27a279701f8 Initial revision
claus
parents:
diff changeset
   165
     should be sent, if we are no more interrested in destruction of
a27a279701f8 Initial revision
claus
parents:
diff changeset
   166
     anObject (i.e. it no longer holds external resources)."
a27a279701f8 Initial revision
claus
parents:
diff changeset
   167
a27a279701f8 Initial revision
claus
parents:
diff changeset
   168
    |index|
a27a279701f8 Initial revision
claus
parents:
diff changeset
   169
a27a279701f8 Initial revision
claus
parents:
diff changeset
   170
    index := registeredObjects identityIndexOf:anObject ifAbsent:[0].
a27a279701f8 Initial revision
claus
parents:
diff changeset
   171
    index ~~ 0 ifTrue:[
a27a279701f8 Initial revision
claus
parents:
diff changeset
   172
        phantoms at:index put:nil.
a27a279701f8 Initial revision
claus
parents:
diff changeset
   173
        registeredObjects at:index put:nil
a27a279701f8 Initial revision
claus
parents:
diff changeset
   174
    ]
a27a279701f8 Initial revision
claus
parents:
diff changeset
   175
! !
2
claus
parents: 1
diff changeset
   176
claus
parents: 1
diff changeset
   177
!Registry methodsFor:'restart handling'!
claus
parents: 1
diff changeset
   178
claus
parents: 1
diff changeset
   179
update:aParameter
10
claus
parents: 3
diff changeset
   180
    aParameter == #earlyRestart ifTrue:[
2
claus
parents: 1
diff changeset
   181
	phantoms notNil ifTrue:[
claus
parents: 1
diff changeset
   182
	    phantoms atAllPut:nil
claus
parents: 1
diff changeset
   183
	]
10
claus
parents: 3
diff changeset
   184
    ].
claus
parents: 3
diff changeset
   185
    aParameter == #returnFromSnapshot ifTrue:[
claus
parents: 3
diff changeset
   186
	cleanState := true
2
claus
parents: 1
diff changeset
   187
    ]
claus
parents: 1
diff changeset
   188
! !