1445
|
1 |
"
|
|
2 |
COPYRIGHT (c) 2003 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 |
"
|
|
12 |
|
1231
|
13 |
"{ Package: 'stx:libbasic3' }"
|
|
14 |
|
|
15 |
"{ NameSpace: Packages }"
|
|
16 |
|
|
17 |
Object subclass:#StxPackageFileWriter
|
|
18 |
instanceVariableNames:'handler stream'
|
|
19 |
classVariableNames:''
|
|
20 |
poolDictionaries:''
|
|
21 |
category:'Package-Handlers'
|
|
22 |
!
|
|
23 |
|
|
24 |
Object subclass:#Version1
|
|
25 |
instanceVariableNames:'package'
|
|
26 |
classVariableNames:''
|
|
27 |
poolDictionaries:''
|
|
28 |
privateIn:StxPackageFileWriter
|
|
29 |
!
|
|
30 |
|
1445
|
31 |
!StxPackageFileWriter class methodsFor:'documentation'!
|
|
32 |
|
|
33 |
copyright
|
|
34 |
"
|
|
35 |
COPYRIGHT (c) 2003 by eXept Software AG
|
|
36 |
All Rights Reserved
|
|
37 |
|
|
38 |
This software is furnished under a license and may be used
|
|
39 |
only in accordance with the terms of that license and with the
|
|
40 |
inclusion of the above copyright notice. This software may not
|
|
41 |
be provided or otherwise made available to, or used by, any
|
|
42 |
other person. No title to or ownership of the software is
|
|
43 |
hereby transferred.
|
|
44 |
"
|
|
45 |
! !
|
1231
|
46 |
|
|
47 |
!StxPackageFileWriter class methodsFor:'instance creation'!
|
|
48 |
|
|
49 |
forPackage:aPackage
|
|
50 |
|
|
51 |
^ (self version:1) forPackage:aPackage
|
|
52 |
!
|
|
53 |
|
|
54 |
version:aVersionNumber
|
|
55 |
|
|
56 |
aVersionNumber == 1 ifTrue:[
|
|
57 |
^ Version1.
|
|
58 |
].
|
|
59 |
self error:'Version unknown'
|
|
60 |
! !
|
|
61 |
|
|
62 |
!StxPackageFileWriter::Version1 class methodsFor:'instance creation'!
|
|
63 |
|
|
64 |
forPackage:aPackage
|
|
65 |
^ self basicNew package:aPackage
|
|
66 |
! !
|
|
67 |
|
|
68 |
!StxPackageFileWriter::Version1 methodsFor:'accessing'!
|
|
69 |
|
|
70 |
fileOutVersion
|
|
71 |
^ 1
|
|
72 |
!
|
|
73 |
|
|
74 |
package
|
|
75 |
"return the value of the instance variable 'package' (automatically generated)"
|
|
76 |
|
|
77 |
^ package
|
|
78 |
!
|
|
79 |
|
|
80 |
package:something
|
|
81 |
"set the value of the instance variable 'package' (automatically generated)"
|
|
82 |
|
|
83 |
package := something.
|
|
84 |
! !
|
|
85 |
|
|
86 |
!StxPackageFileWriter::Version1 methodsFor:'api'!
|
|
87 |
|
|
88 |
savePackageAs:aFilename
|
|
89 |
| writeStream |
|
|
90 |
self createPathFor:aFilename.
|
|
91 |
[
|
|
92 |
self canWriteTo:aFilename. "may return exceptions"
|
|
93 |
writeStream := aFilename writeStream.
|
|
94 |
self savePackageOn:writeStream. "may return exceptions"
|
|
95 |
] ensure:[
|
|
96 |
writeStream close.
|
|
97 |
].
|
|
98 |
|
|
99 |
package markClean.
|
|
100 |
^ package
|
|
101 |
!
|
|
102 |
|
|
103 |
savePackageOn:aWriteStream
|
|
104 |
self forPackage:package saveInstallationScriptChunkOn:aWriteStream.
|
|
105 |
self forPackage:package saveClassDefinitionsOn:aWriteStream.
|
|
106 |
self forPackage:package saveLooseMethodsOn:aWriteStream.
|
|
107 |
! !
|
|
108 |
|
|
109 |
!StxPackageFileWriter::Version1 methodsFor:'fileOut - chunks'!
|
|
110 |
|
|
111 |
forPackage:aPackage saveClassDefinitionsOn:aWriteStream
|
|
112 |
|
|
113 |
aPackage classNames size > 0 ifTrue:[
|
|
114 |
aWriteStream nextPutAll:'"Class Definitions"!!'.
|
|
115 |
aWriteStream cr.
|
1240
|
116 |
aPackage classesDo:[:aClass |
|
|
117 |
aClass nameSpace isNameSpace ifTrue:[
|
|
118 |
self fileOutClass:aClass on:aWriteStream.
|
1238
|
119 |
] ifFalse:[| ownerClass |
|
|
120 |
"aClass is a privateClass"
|
1268
|
121 |
ownerClass := aClass nameSpace.
|
1238
|
122 |
ownerClass package == aPackage name ifFalse:[
|
|
123 |
]. "ifTrue:[
|
|
124 |
Do nothing - the class has already been filed out by its ownerClass!!
|
|
125 |
]."
|
|
126 |
]
|
1231
|
127 |
].
|
|
128 |
aWriteStream cr.
|
|
129 |
aWriteStream nextPutAll:'"End of Class Definitions"!!'.
|
|
130 |
aWriteStream cr.
|
|
131 |
].
|
|
132 |
!
|
|
133 |
|
|
134 |
forPackage:aPackage saveInstallationScriptChunkOn:aWriteStream
|
|
135 |
"create an installation script which is used to create
|
|
136 |
an initial package which can help determine if the package
|
|
137 |
is loadable"
|
|
138 |
self forPackage:aPackage savePackageFormatOn:aWriteStream.
|
|
139 |
self forPackage:aPackage savePackageInstanceCreationOn:aWriteStream.
|
|
140 |
self forPackage:aPackage savePackageFileVersionOn:aWriteStream.
|
|
141 |
self forPackage:aPackage savePackageCommentOn:aWriteStream.
|
|
142 |
self forPackage:aPackage saveClassNamesOn:aWriteStream.
|
|
143 |
self forPackage:aPackage saveLooseMethodNamesOn:aWriteStream.
|
|
144 |
self forPackage:aPackage saveScriptsOn:aWriteStream.
|
|
145 |
self forPackage:aPackage savePrerequisitesOn:aWriteStream.
|
|
146 |
self forPackage:aPackage saveEndingOn:aWriteStream.
|
|
147 |
!
|
|
148 |
|
|
149 |
forPackage:aPackage saveLooseMethodsOn:aWriteStream
|
|
150 |
aPackage looseMethods size > 0 ifTrue:[
|
|
151 |
aWriteStream nextPutAll:'"LooseMethods"!!'.
|
|
152 |
aWriteStream cr.
|
|
153 |
aPackage looseMethods do:[:aLooseMethod |
|
|
154 |
self fileOutLooseMethod:aLooseMethod on:aWriteStream
|
|
155 |
].
|
|
156 |
aWriteStream nextPutAll:'!!'.
|
|
157 |
aWriteStream cr.
|
|
158 |
|
|
159 |
aWriteStream nextPutAll:'"End of LooseMethods"!!'.
|
|
160 |
].
|
|
161 |
! !
|
|
162 |
|
|
163 |
!StxPackageFileWriter::Version1 methodsFor:'fileOut - subparts'!
|
|
164 |
|
|
165 |
fileOutClass:aClass on:aWriteStream
|
|
166 |
|
|
167 |
"ClassDescription fileOutErrorSignal can occur here from autoloaded classes"
|
|
168 |
aClass isLoaded ifFalse:[
|
|
169 |
aClass autoload
|
|
170 |
].
|
|
171 |
|
|
172 |
package blockedMethods isEmpty ifFalse:[
|
|
173 |
Transcript
|
|
174 |
nextPutAll:'Finnish me!!';
|
|
175 |
cr;
|
|
176 |
nextPutAll:'''blockedMethods '' are not accounted for at the moment!!'' in:';
|
|
177 |
cr;
|
|
178 |
nextPutAll:'Packages::StxPackageFileWriter::Version1>>fileOutClass:on:' ;
|
|
179 |
cr
|
|
180 |
|
|
181 |
].
|
|
182 |
aClass fileOutOn:aWriteStream
|
|
183 |
!
|
|
184 |
|
|
185 |
fileOutLooseMethod:aMethod on:aWriteStream
|
|
186 |
|
|
187 |
aWriteStream nextPut:$!!.
|
|
188 |
aWriteStream nextPutAll:aMethod mclass asString.
|
|
189 |
aWriteStream nextPutAll:' methodsFor:'.
|
|
190 |
aWriteStream nextPut:$'.
|
|
191 |
aWriteStream nextPutAll:(aMethod category).
|
|
192 |
aWriteStream nextPut:$'.
|
|
193 |
aWriteStream nextPut:$!!.
|
|
194 |
aWriteStream cr.
|
|
195 |
|
|
196 |
aWriteStream nextPutAll:aMethod source.
|
|
197 |
aWriteStream nextPut:$!!.
|
|
198 |
aWriteStream cr.
|
|
199 |
!
|
|
200 |
|
|
201 |
forPackage:aPackage saveClassNamesOn:aWriteStream
|
|
202 |
|
|
203 |
aPackage classNames size > 0 ifTrue:[
|
|
204 |
|
|
205 |
aWriteStream
|
|
206 |
nextPutAll:'"ClassNames"';
|
|
207 |
cr.
|
|
208 |
|
|
209 |
aWriteStream
|
|
210 |
nextPutAll:'aPackage ';
|
|
211 |
cr.
|
|
212 |
|
|
213 |
aPackage classNames do:[:aClassname |
|
|
214 |
aWriteStream
|
|
215 |
nextPutAll:' addClassNamed:#', aClassname, ';';
|
|
216 |
cr.
|
|
217 |
].
|
|
218 |
|
|
219 |
aWriteStream nextPutAll:' yourself.'; "pointless but makes this code more readable"
|
|
220 |
cr.
|
|
221 |
|
|
222 |
aWriteStream
|
|
223 |
nextPutAll:'"End of ClassNames"';
|
|
224 |
cr;
|
|
225 |
cr.
|
|
226 |
|
|
227 |
].
|
|
228 |
!
|
|
229 |
|
|
230 |
forPackage:aPackage saveEndingOn:aWriteStream
|
|
231 |
aWriteStream
|
|
232 |
nextPutAll:'aPackage!!';
|
|
233 |
cr;
|
|
234 |
cr.
|
|
235 |
!
|
|
236 |
|
|
237 |
forPackage:aPackage saveLooseMethodNamesOn:aWriteStream
|
|
238 |
|
|
239 |
aPackage looseMethods size > 0 ifTrue:[
|
|
240 |
|
|
241 |
aWriteStream
|
|
242 |
nextPutAll:'"LooseMethodNames"';
|
|
243 |
cr.
|
|
244 |
|
|
245 |
aWriteStream
|
|
246 |
nextPutAll:'aPackage ';
|
|
247 |
cr.
|
|
248 |
|
|
249 |
aPackage looseMethods do:[:aMethod |
|
|
250 |
aWriteStream
|
1268
|
251 |
nextPutAll:' addMethodNamed:#', aMethod name asString, ' forClassNamed:#', aMethod ownedClassName asString, ';';
|
1231
|
252 |
cr.
|
|
253 |
].
|
|
254 |
|
|
255 |
aWriteStream nextPutAll:' yourself.'. "pointless but makes this code more readable"
|
|
256 |
aWriteStream
|
|
257 |
cr;
|
|
258 |
nextPutAll:'"End of LooseMethodNames"';
|
|
259 |
cr;
|
|
260 |
cr.
|
|
261 |
].
|
|
262 |
!
|
|
263 |
|
|
264 |
forPackage:aPackage savePackageCommentOn:aWriteStream
|
|
265 |
aWriteStream
|
|
266 |
nextPutAll:'aPackage packageComment:';
|
|
267 |
nextPutAll:aPackage packageComment ? '''''';
|
|
268 |
nextPut:$.;
|
|
269 |
cr;
|
|
270 |
cr.
|
|
271 |
!
|
|
272 |
|
|
273 |
forPackage:aPackage savePackageFileVersionOn:aWriteStream
|
|
274 |
|
|
275 |
aWriteStream
|
|
276 |
nextPutAll:'aPackage packageVersion:';
|
|
277 |
nextPutAll:self fileOutVersion printString;
|
|
278 |
nextPut:$.;
|
|
279 |
cr.
|
|
280 |
!
|
|
281 |
|
|
282 |
forPackage:aPackage savePackageFormatOn:aWriteStream
|
|
283 |
aWriteStream nextPutAll:'!!Packages::PackageHandler openStxPackageFormat:1!!';
|
|
284 |
cr
|
|
285 |
!
|
|
286 |
|
|
287 |
forPackage:aPackage savePackageInstanceCreationOn:aWriteStream
|
|
288 |
aWriteStream
|
|
289 |
nextPutAll:'|aPackage|';
|
|
290 |
cr;
|
|
291 |
nextPutAll:'aPackage := Package named: ';
|
|
292 |
nextPut:$';
|
|
293 |
nextPutAll:aPackage name;
|
|
294 |
nextPut:$';
|
|
295 |
nextPut:$.;
|
|
296 |
cr.
|
|
297 |
!
|
|
298 |
|
|
299 |
forPackage:aPackage savePrerequisitesOn:aWriteStream
|
|
300 |
|
|
301 |
aPackage prerequisites size > 0 ifTrue:[
|
|
302 |
aWriteStream
|
|
303 |
nextPutAll:'"Prerequisites"';
|
|
304 |
cr.
|
|
305 |
|
|
306 |
self forPackage:aPackage savePrerequisteClassesOn:aWriteStream.
|
|
307 |
self forPackage:aPackage savePrerequistePackagesOn:aWriteStream.
|
|
308 |
aWriteStream
|
|
309 |
nextPutAll:'"End of Prerequisites"';
|
|
310 |
cr;
|
|
311 |
cr.
|
|
312 |
|
|
313 |
]
|
|
314 |
|
|
315 |
!
|
|
316 |
|
|
317 |
forPackage:aPackage savePrerequisteClassesOn:aWriteStream
|
|
318 |
|
|
319 |
aPackage classPrerequisites size > 0 ifTrue:[
|
|
320 |
|
|
321 |
aPackage classPrerequisites do:[:prerequisite |
|
|
322 |
|
|
323 |
aWriteStream
|
|
324 |
nextPutAll:'aPackage' ;
|
|
325 |
cr;
|
|
326 |
nextPutAll:' addClassNamePrerequisite:#', prerequisite name;
|
|
327 |
cr;
|
|
328 |
nextPutAll:' ifFailString:';
|
|
329 |
nextPut:$';
|
|
330 |
nextPutAll:prerequisite ifFailedString;
|
|
331 |
nextPut:$';
|
|
332 |
nextPut:$;;
|
|
333 |
cr.
|
|
334 |
].
|
|
335 |
|
|
336 |
aWriteStream nextPutAll:' yourself.'; "pointless but makes this code more readable"
|
|
337 |
cr.
|
|
338 |
|
|
339 |
|
|
340 |
].
|
|
341 |
!
|
|
342 |
|
|
343 |
forPackage:aPackage savePrerequistePackagesOn:aWriteStream
|
|
344 |
|
|
345 |
aPackage packagePrerequisites size > 0 ifTrue:[
|
|
346 |
|
|
347 |
aPackage packagePrerequisites do:[:prerequisite |
|
|
348 |
|
|
349 |
aWriteStream
|
|
350 |
nextPutAll:'aPackage' ;
|
|
351 |
cr;
|
|
352 |
nextPutAll:' addPackageNamePrerequisite:#', prerequisite name;
|
|
353 |
cr;
|
|
354 |
nextPutAll:' ifFailString:';
|
|
355 |
nextPut:$';
|
|
356 |
nextPutAll:prerequisite ifFailedString;
|
|
357 |
nextPut:$';
|
|
358 |
nextPut:$;;
|
|
359 |
cr.
|
|
360 |
].
|
|
361 |
|
|
362 |
aWriteStream nextPutAll:' yourself.'; "pointless but makes this code more readable"
|
|
363 |
cr.
|
|
364 |
]
|
|
365 |
!
|
|
366 |
|
|
367 |
forPackage:aPackage saveScriptsOn:aWriteStream
|
|
368 |
|
|
369 |
aPackage scripts size > 0 ifTrue:[ | aScript |
|
|
370 |
|
|
371 |
aWriteStream
|
|
372 |
nextPutAll:'"Scripts"';
|
|
373 |
cr.
|
|
374 |
(aScript := aPackage postInstallScript) getString size == 0 ifFalse:[
|
|
375 |
aWriteStream
|
|
376 |
nextPutAll:'aPackage postInstallScriptString:';
|
|
377 |
nextPut:$';
|
|
378 |
nextPutAll:aScript getString;
|
|
379 |
nextPut:$';
|
|
380 |
nextPut:$.;
|
|
381 |
cr.
|
|
382 |
].
|
|
383 |
|
|
384 |
(aScript := aPackage preInstallScript) getString size == 0 ifFalse:[
|
|
385 |
aWriteStream
|
|
386 |
nextPutAll:'aPackage preInstallScriptString:';
|
|
387 |
nextPut:$';
|
|
388 |
nextPutAll:aScript getString;
|
|
389 |
nextPut:$';
|
|
390 |
nextPut:$.;
|
|
391 |
cr.
|
|
392 |
].
|
|
393 |
|
|
394 |
(aScript := aPackage postUninstallScript) getString size == 0 ifFalse:[
|
|
395 |
aWriteStream
|
|
396 |
nextPutAll:'aPackage postUninstallScriptString:';
|
|
397 |
nextPut:$';
|
|
398 |
nextPutAll:aScript getString;
|
|
399 |
nextPut:$';
|
|
400 |
nextPut:$.;
|
|
401 |
cr.
|
|
402 |
].
|
|
403 |
|
|
404 |
(aScript := aPackage postUninstallScript) getString size == 0 ifFalse:[
|
|
405 |
aWriteStream
|
|
406 |
nextPutAll:'aPackage preUninstallScriptString:';
|
|
407 |
nextPut:$';
|
|
408 |
nextPutAll:aScript getString;
|
|
409 |
nextPut:$';
|
|
410 |
nextPut:$.;
|
|
411 |
cr.
|
|
412 |
].
|
|
413 |
aWriteStream
|
|
414 |
cr;
|
|
415 |
cr.
|
|
416 |
|
|
417 |
|
|
418 |
].
|
|
419 |
! !
|
|
420 |
|
|
421 |
!StxPackageFileWriter::Version1 methodsFor:'helpers'!
|
|
422 |
|
|
423 |
createPathFor:aFilename
|
|
424 |
" create the path name for the filename if it does not already exist"
|
|
425 |
^ aFilename directory makeDirectory.
|
|
426 |
! !
|
|
427 |
|
|
428 |
!StxPackageFileWriter::Version1 methodsFor:'instance creation'!
|
|
429 |
|
|
430 |
forPackage:aPackage
|
|
431 |
^ self basicNew package:aPackage
|
|
432 |
! !
|
|
433 |
|
|
434 |
!StxPackageFileWriter::Version1 methodsFor:'queries'!
|
|
435 |
|
|
436 |
canWriteTo:aFilename
|
|
437 |
"return an error if the reciever cannot write to aFilename"
|
|
438 |
|
|
439 |
aFilename isFilename ifFalse:[
|
|
440 |
^ self error:aFilename printString, ' is not a filename so cannot be written to.'.
|
|
441 |
].
|
|
442 |
|
|
443 |
aFilename directory exists ifFalse:[
|
|
444 |
^ self error:aFilename directory printString, ' directory does not exist.'.
|
|
445 |
].
|
|
446 |
|
|
447 |
aFilename directory canBeWritten ifFalse:[
|
|
448 |
^ self error:aFilename printString, ' cannot be written to.'.
|
|
449 |
].
|
|
450 |
|
|
451 |
(aFilename isDirectory not) ifFalse:[
|
|
452 |
^ self error:aFilename printString, ' is a directory and cannot be written to'.
|
|
453 |
].
|
|
454 |
! !
|
|
455 |
|
|
456 |
!StxPackageFileWriter class methodsFor:'documentation'!
|
|
457 |
|
|
458 |
version
|
1445
|
459 |
^ '$Header: /cvs/stx/stx/libbasic3/packages/StxPackageFileWriter.st,v 1.5 2006-01-10 09:31:44 cg Exp $'
|
1231
|
460 |
! !
|