author | Claus Gittinger <cg@exept.de> |
Mon, 16 Dec 2019 16:00:23 +0100 | |
changeset 25135 | 98f799af1e48 |
parent 24424 | 9e79e32cc079 |
child 25354 | ee0e8cf9d49d |
permissions | -rw-r--r-- |
10847 | 1 |
" |
2 |
COPYRIGHT (c) 2007 by eXept Software AG |
|
3 |
All Rights Reserved |
|
4 |
||
5 |
This software is furnished under a license and may be used |
|
6 |
only in accordance with the terms of that license and with the |
|
7 |
inclusion of the above copyright notice. This software may not |
|
8 |
be provided or otherwise made available to, or used by, any |
|
9 |
other person. No title to or ownership of the software is |
|
10 |
hereby transferred. |
|
11 |
" |
|
10761 | 12 |
"{ Package: 'stx:libbasic' }" |
13 |
||
18632 | 14 |
"{ NameSpace: Smalltalk }" |
15 |
||
10761 | 16 |
Filename subclass:#AutoDeletedFilename |
23665 | 17 |
instanceVariableNames:'concreteFilename' |
18632 | 18 |
classVariableNames:'Lobby' |
10761 | 19 |
poolDictionaries:'' |
20 |
category:'System-Support' |
|
21 |
! |
|
22 |
||
23 |
!AutoDeletedFilename class methodsFor:'documentation'! |
|
24 |
||
10847 | 25 |
copyright |
26 |
" |
|
27 |
COPYRIGHT (c) 2007 by eXept Software AG |
|
28 |
All Rights Reserved |
|
29 |
||
30 |
This software is furnished under a license and may be used |
|
31 |
only in accordance with the terms of that license and with the |
|
32 |
inclusion of the above copyright notice. This software may not |
|
33 |
be provided or otherwise made available to, or used by, any |
|
34 |
other person. No title to or ownership of the software is |
|
35 |
hereby transferred. |
|
36 |
" |
|
37 |
! |
|
38 |
||
10761 | 39 |
documentation |
40 |
" |
|
41 |
Used with temporary files - these will automatically delete themself, |
|
21277 | 42 |
when no longer referenced (i.e. when finalized) |
43 |
||
10761 | 44 |
See -> Filename asAutoDeletedFilename |
21277 | 45 |
|
23665 | 46 |
[instance variables:] |
47 |
concreteFilename UnixFilename|PCFilename the concrete filename that |
|
48 |
implements the OS-specific behavior |
|
21277 | 49 |
[author:] |
50 |
cg - original code |
|
51 |
sv - fixed and enhanced |
|
10761 | 52 |
" |
53 |
! |
|
54 |
||
55 |
examples |
|
56 |
" |
|
57 |
the following file will be automatically deleted after some time: |
|
10931
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
58 |
[exBegin] |
10761 | 59 |
|f p| |
60 |
||
15247 | 61 |
f := AutoDeletedFilename newTemporary. |
10761 | 62 |
f writeStream |
63 |
nextPutLine:'hello'; |
|
64 |
close. |
|
65 |
p := f pathName. |
|
66 |
Transcript showCR:p. |
|
67 |
f := f asAutoDeletedFilename. |
|
68 |
self assert:(p asFilename exists). |
|
69 |
ObjectMemory collectGarbage. |
|
70 |
Delay waitForSeconds:2. |
|
71 |
self assert:(p asFilename exists). |
|
72 |
f := nil. |
|
73 |
ObjectMemory collectGarbage. |
|
74 |
Delay waitForSeconds:2. |
|
75 |
self assert:(p asFilename exists not). |
|
10931
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
76 |
[exEnd] |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
77 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
78 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
79 |
you can also delete it manually: |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
80 |
[exBegin] |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
81 |
|f p| |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
82 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
83 |
f := Filename newTemporary. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
84 |
f writeStream |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
85 |
nextPutLine:'hello'; |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
86 |
close. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
87 |
p := f pathName. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
88 |
Transcript showCR:p. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
89 |
f := f asAutoDeletedFilename. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
90 |
self assert:(p asFilename exists). |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
91 |
ObjectMemory collectGarbage. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
92 |
Delay waitForSeconds:2. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
93 |
self assert:(p asFilename exists). |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
94 |
f remove. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
95 |
f := nil. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
96 |
ObjectMemory collectGarbage. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
97 |
Delay waitForSeconds:2. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
98 |
self assert:(p asFilename exists not). |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
99 |
[exEnd] |
10761 | 100 |
" |
101 |
! ! |
|
102 |
||
18632 | 103 |
!AutoDeletedFilename class methodsFor:'initialization'! |
104 |
||
105 |
initialize |
|
106 |
Lobby isNil ifTrue:[ |
|
107 |
Lobby := Registry new. |
|
108 |
]. |
|
109 |
Smalltalk addDependent:self. "inform me when smalltalk exits" |
|
110 |
! ! |
|
111 |
||
23665 | 112 |
!AutoDeletedFilename class methodsFor:'instance creation'! |
113 |
||
114 |
named:aString |
|
115 |
"return a filename for a directory named aString. |
|
116 |
This is the same as 'aString asFilename'." |
|
117 |
||
118 |
^ self basicNew setName:aString |
|
119 |
||
120 |
"Created: / 06-02-2019 / 10:15:01 / Stefan Vogel" |
|
121 |
! ! |
|
122 |
||
24424 | 123 |
!AutoDeletedFilename class methodsFor:'change & update'! |
18632 | 124 |
|
125 |
update:anAspect with:aParameter from:changedObject |
|
126 |
"when Smalltalk exits, remove all auto deleted files" |
|
127 |
||
128 |
anAspect == #aboutToQuit ifTrue:[ |
|
129 |
|currentFilename| |
|
130 |
"do it with timeout in case of a non-responding remote file server" |
|
131 |
([ |
|
132 |
Lobby do:[:each| |
|
133 |
currentFilename := each. |
|
134 |
each basicFinalize |
|
135 |
]. |
|
136 |
] valueWithTimeout:1 minutes) isNil ifTrue:[ |
|
137 |
'AutoDeletedFilename: timed out while removing: ' errorPrint. currentFilename errorPrintCR. |
|
138 |
]. |
|
139 |
]. |
|
18634 | 140 |
super update:anAspect with:aParameter from:changedObject |
18632 | 141 |
! ! |
142 |
||
10761 | 143 |
!AutoDeletedFilename methodsFor:'accessing'! |
144 |
||
23666 | 145 |
concreteFilename:aFilename |
146 |
concreteFilename := aFilename. |
|
147 |
||
148 |
"Modified (format): / 06-02-2019 / 11:45:44 / Stefan Vogel" |
|
23665 | 149 |
! |
150 |
||
15470 | 151 |
keep |
152 |
"do not delete the file on finalization" |
|
153 |
||
154 |
self unregisterForFinalization |
|
155 |
! |
|
156 |
||
157 |
setName:aString |
|
158 |
super setName:aString. |
|
23665 | 159 |
concreteFilename := ConcreteClass named:aString. |
160 |
self registerForFinalization |
|
161 |
||
162 |
"Modified: / 06-02-2019 / 10:16:06 / Stefan Vogel" |
|
163 |
! |
|
164 |
||
165 |
species |
|
166 |
"filenames derived from me should not be autodeleted themself" |
|
167 |
||
168 |
^ ConcreteClass. "of Filename" |
|
169 |
||
170 |
"Modified: / 06-02-2019 / 10:06:23 / Stefan Vogel" |
|
171 |
! ! |
|
172 |
||
173 |
!AutoDeletedFilename methodsFor:'converting'! |
|
174 |
||
175 |
asAutoDeletedFilename |
|
176 |
"that's what I am" |
|
177 |
||
178 |
^ self |
|
179 |
||
180 |
"Created: / 06-02-2019 / 10:10:43 / Stefan Vogel" |
|
15470 | 181 |
! ! |
182 |
||
183 |
!AutoDeletedFilename methodsFor:'copying'! |
|
184 |
||
185 |
shallowCopy |
|
186 |
"when copying, return a real filename |
|
187 |
(to avoid mutiple removals)" |
|
188 |
||
15810 | 189 |
^ self species named:nameString |
15470 | 190 |
|
191 |
" |
|
192 |
'blaFaselQall.mist' asFilename asAutoDeletedFilename copy |
|
193 |
" |
|
194 |
! ! |
|
195 |
||
23665 | 196 |
!AutoDeletedFilename methodsFor:'delegated to concrete filename'! |
197 |
||
198 |
directoryName |
|
199 |
^ concreteFilename directoryName. |
|
200 |
||
201 |
"Modified: / 07-09-1995 / 10:42:03 / claus" |
|
202 |
"Modified: / 21-10-1998 / 22:52:25 / cg" |
|
203 |
"Modified: / 27-10-1998 / 13:19:26 / ps" |
|
204 |
"Modified: / 06-02-2019 / 10:52:20 / Stefan Vogel" |
|
205 |
! |
|
206 |
||
207 |
fileType |
|
208 |
^ concreteFilename fileType. |
|
209 |
||
210 |
"Modified: / 21-07-1998 / 11:25:56 / cg" |
|
211 |
"Modified: / 06-02-2019 / 10:50:51 / Stefan Vogel" |
|
212 |
! |
|
213 |
||
214 |
fullAlternativePathName |
|
215 |
^ concreteFilename fullAlternativePathName. |
|
216 |
||
217 |
"Modified: / 06-02-2019 / 10:53:56 / Stefan Vogel" |
|
218 |
! |
|
219 |
||
220 |
isDirectory |
|
221 |
^ concreteFilename isDirectory. |
|
222 |
||
223 |
"Modified: / 21-09-1998 / 15:53:10 / cg" |
|
224 |
"Modified: / 06-02-2019 / 10:51:48 / Stefan Vogel" |
|
225 |
! |
|
226 |
||
227 |
isExecutableProgram |
|
228 |
^ concreteFilename isExecutableProgram. |
|
229 |
||
230 |
"Modified: / 06-02-2019 / 10:54:15 / Stefan Vogel" |
|
231 |
! |
|
232 |
||
233 |
isExplicitRelative |
|
234 |
^ concreteFilename isExplicitRelative. |
|
235 |
||
236 |
"Modified: / 06-02-2019 / 10:52:48 / Stefan Vogel" |
|
237 |
! |
|
238 |
||
239 |
isHidden |
|
240 |
^ concreteFilename isHidden. |
|
241 |
||
242 |
"Modified: / 06-02-2019 / 10:54:30 / Stefan Vogel" |
|
243 |
! |
|
244 |
||
245 |
isImplicit |
|
246 |
^ concreteFilename isImplicit. |
|
247 |
||
248 |
"Created: / 18-09-1997 / 18:04:51 / stefan" |
|
249 |
"Modified: / 06-02-2019 / 10:53:08 / Stefan Vogel" |
|
250 |
! |
|
251 |
||
252 |
isRootDirectory |
|
253 |
^ concreteFilename isRootDirectory. |
|
254 |
||
255 |
"Modified: / 06-02-2019 / 10:20:31 / Stefan Vogel" |
|
256 |
! |
|
257 |
||
258 |
isVolumeAbsolute |
|
259 |
^ concreteFilename isVolumeAbsolute. |
|
260 |
||
261 |
"Created: / 07-09-1997 / 23:54:20 / cg" |
|
262 |
"Modified: / 09-09-1998 / 20:38:54 / cg" |
|
263 |
"Modified: / 06-02-2019 / 10:20:43 / Stefan Vogel" |
|
264 |
! |
|
265 |
||
266 |
localPathName |
|
267 |
^ concreteFilename localPathName. |
|
268 |
||
269 |
"Modified: / 24-09-1998 / 19:09:53 / cg" |
|
270 |
"Modified (format): / 06-02-2019 / 10:21:08 / Stefan Vogel" |
|
271 |
! |
|
272 |
||
273 |
makeLegalFilename |
|
274 |
^ concreteFilename makeLegalFilename. |
|
275 |
||
276 |
"Modified: / 01-12-2010 / 18:53:59 / cg" |
|
277 |
"Modified: / 06-02-2019 / 10:21:28 / Stefan Vogel" |
|
278 |
! |
|
279 |
||
280 |
osNameForAccess |
|
281 |
^ concreteFilename osNameForAccess. |
|
282 |
||
283 |
"Modified: / 06-02-2019 / 10:21:47 / Stefan Vogel" |
|
284 |
! |
|
285 |
||
286 |
osNameForDirectory |
|
287 |
^ concreteFilename osNameForDirectory. |
|
288 |
||
289 |
"Modified: / 20-01-1998 / 15:39:06 / md" |
|
290 |
"Modified: / 17-08-1998 / 10:04:01 / cg" |
|
291 |
"Modified: / 06-02-2019 / 10:22:02 / Stefan Vogel" |
|
292 |
! |
|
293 |
||
294 |
osNameForDirectoryContents |
|
295 |
^ concreteFilename osNameForDirectoryContents. |
|
296 |
||
297 |
"Modified: / 20-01-1998 / 15:39:06 / md" |
|
298 |
"Created: / 03-08-1998 / 21:37:46 / cg" |
|
299 |
"Modified: / 17-08-1998 / 10:04:22 / cg" |
|
300 |
"Modified: / 06-02-2019 / 10:22:21 / Stefan Vogel" |
|
301 |
! |
|
302 |
||
303 |
osNameForFile |
|
304 |
^ concreteFilename osNameForFile. |
|
305 |
||
306 |
"Modified: / 21-07-2012 / 19:35:19 / cg" |
|
307 |
"Modified: / 06-02-2019 / 10:22:32 / Stefan Vogel" |
|
308 |
! |
|
309 |
||
310 |
pathName |
|
311 |
^ concreteFilename pathName. |
|
312 |
||
313 |
"Modified: / 24-09-1998 / 19:09:53 / cg" |
|
314 |
"Modified: / 06-02-2019 / 10:22:43 / Stefan Vogel" |
|
315 |
! |
|
316 |
||
317 |
renameTo:newName |
|
318 |
^ concreteFilename renameTo:newName. |
|
319 |
||
320 |
"Modified: / 20-01-1998 / 15:33:00 / md" |
|
321 |
"Modified: / 21-09-2006 / 18:19:47 / cg" |
|
322 |
"Modified (format): / 12-12-2017 / 12:45:47 / stefan" |
|
323 |
"Modified: / 06-02-2019 / 10:22:59 / Stefan Vogel" |
|
324 |
! |
|
325 |
||
326 |
setHidden |
|
327 |
^ concreteFilename setHidden. |
|
328 |
||
329 |
"Modified: / 06-02-2019 / 10:23:25 / Stefan Vogel" |
|
330 |
! |
|
331 |
||
332 |
volume |
|
333 |
^ concreteFilename volume. |
|
334 |
||
335 |
"Modified: / 24-09-1998 / 19:04:27 / cg" |
|
336 |
"Modified: / 06-02-2019 / 10:23:54 / Stefan Vogel" |
|
337 |
! ! |
|
338 |
||
15470 | 339 |
!AutoDeletedFilename methodsFor:'finalization'! |
340 |
||
18632 | 341 |
basicFinalize |
342 |
|linkInfo| |
|
343 |
||
344 |
linkInfo := self linkInfo. |
|
345 |
linkInfo notNil ifTrue:[ |
|
346 |
linkInfo isDirectory ifTrue:[ |
|
23666 | 347 |
concreteFilename recursiveRemove |
18632 | 348 |
] ifFalse:[ |
23666 | 349 |
concreteFilename removeFile. |
18632 | 350 |
]. |
351 |
]. |
|
23666 | 352 |
|
353 |
"Modified: / 06-02-2019 / 12:08:40 / Stefan Vogel" |
|
18632 | 354 |
! |
355 |
||
15470 | 356 |
executor |
23665 | 357 |
^ self class basicNew |
358 |
nameString:nameString; |
|
23666 | 359 |
concreteFilename:concreteFilename; |
360 |
yourself. |
|
23665 | 361 |
|
23666 | 362 |
"Modified: / 06-02-2019 / 11:39:20 / Stefan Vogel" |
15470 | 363 |
! |
364 |
||
18632 | 365 |
finalizationLobby |
366 |
"answer the registry used for finalization. |
|
367 |
we have our own Lobby." |
|
368 |
||
369 |
^ Lobby |
|
370 |
! |
|
371 |
||
10761 | 372 |
finalize |
16550 | 373 |
"/ do this in a forked process to avoid blocking |
374 |
"/ in case of an autodeleted remote file of a broken connection |
|
375 |
[ |
|
376 |
"/ with timeout to avoid waiting forever |
|
377 |
[ |
|
18632 | 378 |
self basicFinalize. |
16550 | 379 |
] valueWithTimeout:1 minutes. |
380 |
] fork. |
|
10761 | 381 |
! ! |
382 |
||
10931
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
383 |
!AutoDeletedFilename methodsFor:'removing'! |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
384 |
|
11780
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
385 |
recursiveRemove |
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
386 |
super recursiveRemove. |
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
387 |
self unregisterForFinalization |
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
388 |
! |
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
389 |
|
10931
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
390 |
remove |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
391 |
super remove. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
392 |
self unregisterForFinalization |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
393 |
! |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
394 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
395 |
removeDirectory |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
396 |
super removeDirectory. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
397 |
self unregisterForFinalization |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
398 |
! |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
399 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
400 |
removeFile |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
401 |
super removeFile. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
402 |
self unregisterForFinalization |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
403 |
! ! |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
404 |
|
10761 | 405 |
!AutoDeletedFilename class methodsFor:'documentation'! |
406 |
||
407 |
version |
|
18632 | 408 |
^ '$Header$' |
18634 | 409 |
! |
410 |
||
411 |
version_CVS |
|
412 |
^ '$Header$' |
|
10761 | 413 |
! ! |
15247 | 414 |
|
18632 | 415 |
|
416 |
AutoDeletedFilename initialize! |