|
478
|
1 |
Object subclass:#HTMLDocGenerator
|
|
|
2 |
instanceVariableNames:''
|
|
|
3 |
classVariableNames:''
|
|
|
4 |
poolDictionaries:''
|
|
|
5 |
category:'System-Documentation'
|
|
|
6 |
!
|
|
|
7 |
|
|
|
8 |
!HTMLDocGenerator class methodsFor:'documentation'!
|
|
|
9 |
|
|
|
10 |
documentation
|
|
|
11 |
"
|
|
|
12 |
helper class to generate HTML docuemntation
|
|
|
13 |
for classes - see DocViewers Class Documentation.
|
|
|
14 |
|
|
|
15 |
[author:]
|
|
|
16 |
Claus Gittinger
|
|
|
17 |
"
|
|
|
18 |
! !
|
|
|
19 |
|
|
|
20 |
!HTMLDocGenerator class methodsFor:'document generation'!
|
|
|
21 |
|
|
|
22 |
htmlClassCategoryList
|
|
|
23 |
|classes categories s prefixList prefix prefixStack indent prev|
|
|
|
24 |
|
|
|
25 |
categories := Set new.
|
|
|
26 |
|
|
|
27 |
Smalltalk allClasses do:[:cls |
|
|
|
28 |
categories add:cls category
|
|
|
29 |
].
|
|
|
30 |
|
|
|
31 |
categories := categories asOrderedCollection sort.
|
|
|
32 |
|
|
|
33 |
s := '' writeStream.
|
|
|
34 |
|
|
|
35 |
s nextPutAll:'
|
|
|
36 |
<html>
|
|
|
37 |
<head>
|
|
|
38 |
<title>
|
|
|
39 |
Class categories:
|
|
|
40 |
</title>
|
|
|
41 |
</head>
|
|
|
42 |
<body>
|
|
|
43 |
<a NOPRINT HREF="TOP.html"> <IMG SRC="../icons/DocsUpArrow.gif" ALT="back"></A>
|
|
|
44 |
|
|
|
45 |
<hr>
|
|
|
46 |
<h1>Class categories:</h1>
|
|
|
47 |
|
|
|
48 |
<ul>
|
|
|
49 |
'.
|
|
|
50 |
|
|
|
51 |
prefixList := Set new.
|
|
|
52 |
|
|
|
53 |
categories keysAndValuesDo:[:index :element |
|
|
|
54 |
|prev common|
|
|
|
55 |
|
|
|
56 |
index ~~ 1 ifTrue:[
|
|
|
57 |
prev := categories at:(index - 1).
|
|
|
58 |
common := (Array with:prev with:element) longestCommonPrefix.
|
|
|
59 |
(common endsWith:'-') ifTrue:[
|
|
|
60 |
prefixList add:(common copyWithoutLast:1)
|
|
|
61 |
] ifFalse:[
|
|
|
62 |
common = prev ifTrue:[
|
|
|
63 |
prefixList add:common
|
|
|
64 |
]
|
|
|
65 |
]
|
|
|
66 |
]
|
|
|
67 |
].
|
|
|
68 |
|
|
|
69 |
prefix := ''. prefixStack := OrderedCollection new.
|
|
|
70 |
prev := ''.
|
|
|
71 |
|
|
|
72 |
categories := categories select:[:nm | nm ~= 'obsolete'].
|
|
|
73 |
|
|
|
74 |
categories do:[:nm |
|
|
|
75 |
|longest|
|
|
|
76 |
|
|
|
77 |
"/ longest prefix ....
|
|
|
78 |
longest := prefixList inject:'' into:[:maxPrefix :prefix |
|
|
|
79 |
nm = prefix ifTrue:[
|
|
|
80 |
maxPrefix
|
|
|
81 |
] ifFalse:[
|
|
|
82 |
(nm startsWith:prefix)
|
|
|
83 |
ifTrue:[
|
|
|
84 |
prefix size > maxPrefix size
|
|
|
85 |
ifTrue:[
|
|
|
86 |
prefix
|
|
|
87 |
] ifFalse:[
|
|
|
88 |
maxPrefix
|
|
|
89 |
]
|
|
|
90 |
] ifFalse:[
|
|
|
91 |
maxPrefix
|
|
|
92 |
]
|
|
|
93 |
]
|
|
|
94 |
].
|
|
|
95 |
|
|
|
96 |
longest size > 0 ifTrue:[
|
|
|
97 |
longest = prefix ifTrue:[
|
|
|
98 |
"/ no change
|
|
|
99 |
] ifFalse:[
|
|
|
100 |
(longest startsWith:prefix) ifTrue:[
|
|
|
101 |
prefixStack addLast:longest.
|
|
|
102 |
longest ~= prev ifTrue:[
|
|
|
103 |
prefixStack size == 1 ifTrue:[
|
|
|
104 |
s nextPutAll:'<p>';cr.
|
|
|
105 |
].
|
|
|
106 |
s nextPutAll:'<li>' , longest ;cr.
|
|
|
107 |
].
|
|
|
108 |
s nextPutAll:'<ul>'; cr.
|
|
|
109 |
prefix := longest.
|
|
|
110 |
] ifFalse:[
|
|
|
111 |
s nextPutAll:'</ul>';cr.
|
|
|
112 |
prefixStack removeLast.
|
|
|
113 |
|
|
|
114 |
[prefixStack notEmpty
|
|
|
115 |
and:[(longest startsWith:prefixStack last) not]] whileTrue:[
|
|
|
116 |
s nextPutAll:'</ul>';cr.
|
|
|
117 |
prefixStack removeLast.
|
|
|
118 |
].
|
|
|
119 |
|
|
|
120 |
prefixStack notEmpty ifTrue:[
|
|
|
121 |
prefix := prefixStack last.
|
|
|
122 |
] ifFalse:[
|
|
|
123 |
prefixStack addLast:longest.
|
|
|
124 |
prefix := longest.
|
|
|
125 |
longest ~= prev ifTrue:[
|
|
|
126 |
prefixStack size == 1 ifTrue:[
|
|
|
127 |
s nextPutAll:'<p>';cr.
|
|
|
128 |
].
|
|
|
129 |
s nextPutAll:'<li>' , longest ;cr.
|
|
|
130 |
].
|
|
|
131 |
s nextPutAll:'<ul>'; cr.
|
|
|
132 |
]
|
|
|
133 |
].
|
|
|
134 |
]
|
|
|
135 |
] ifFalse:[
|
|
|
136 |
[prefixStack size > 0] whileTrue:[
|
|
|
137 |
s nextPutAll:'</ul>';cr.
|
|
|
138 |
prefixStack removeLast.
|
|
|
139 |
].
|
|
|
140 |
prefixStack size == 0 ifTrue:[
|
|
|
141 |
s nextPutAll:'<p>';cr.
|
|
|
142 |
].
|
|
|
143 |
prefix := ''.
|
|
|
144 |
].
|
|
|
145 |
|
|
|
146 |
s nextPutAll:'<li><a href="../misc/onlyInSTX2.html" action="html:'
|
|
|
147 |
, self name
|
|
|
148 |
, ' htmlClassesListOfCategory:''' , nm
|
|
|
149 |
, ''' backTo:''htmlClassCategoryList''">'
|
|
|
150 |
"/ full name:
|
|
|
151 |
"/ , nm ,'</a>';cr.
|
|
|
152 |
|
|
|
153 |
"/ cut off prefix:
|
|
|
154 |
, (nm copyFrom:prefix size + 1) ,'</a>';cr.
|
|
|
155 |
prev := nm.
|
|
|
156 |
].
|
|
|
157 |
|
|
|
158 |
s nextPutAll:'
|
|
|
159 |
</ul>
|
|
|
160 |
|
|
|
161 |
</body>
|
|
|
162 |
</html>
|
|
|
163 |
'.
|
|
|
164 |
|
|
|
165 |
^ s contents
|
|
|
166 |
|
|
|
167 |
"
|
|
|
168 |
HTMLDocGenerator htmlClassCategoryList
|
|
|
169 |
"
|
|
|
170 |
|
|
|
171 |
"Created: 22.4.1996 / 20:03:30 / cg"
|
|
|
172 |
"Modified: 7.9.1996 / 19:59:55 / cg"
|
|
|
173 |
!
|
|
|
174 |
|
|
|
175 |
htmlClassListPrefix:prefix
|
|
|
176 |
|classes|
|
|
|
177 |
|
|
|
178 |
classes := Smalltalk allClasses
|
|
|
179 |
select:[:cls | cls name startsWith:prefix].
|
|
|
180 |
|
|
|
181 |
^ self htmlClasses:classes title:('Classes starting with ''' , prefix asString , ''':').
|
|
|
182 |
|
|
|
183 |
"Modified: 20.4.1996 / 22:42:13 / cg"
|
|
|
184 |
"Created: 22.4.1996 / 20:03:31 / cg"
|
|
|
185 |
!
|
|
|
186 |
|
|
|
187 |
htmlClasses:classes title:title
|
|
|
188 |
^ self
|
|
|
189 |
htmlClasses:classes
|
|
|
190 |
title:title
|
|
|
191 |
backTo:nil
|
|
|
192 |
|
|
|
193 |
"Modified: 23.4.1996 / 15:32:10 / cg"
|
|
|
194 |
!
|
|
|
195 |
|
|
|
196 |
htmlClasses:classes title:title backTo:backRef
|
|
|
197 |
|classNames s|
|
|
|
198 |
|
|
|
199 |
classNames := (classes collect:[:cls | cls name]) asOrderedCollection sort.
|
|
|
200 |
|
|
|
201 |
s := '' writeStream.
|
|
|
202 |
|
|
|
203 |
|
|
|
204 |
s nextPutAll:'
|
|
|
205 |
<html>
|
|
|
206 |
<head>
|
|
|
207 |
<title>
|
|
|
208 |
'.
|
|
|
209 |
s nextPutAll:title.
|
|
|
210 |
s nextPutAll:'
|
|
|
211 |
</title>
|
|
|
212 |
</head>
|
|
|
213 |
<body>
|
|
|
214 |
'.
|
|
|
215 |
backRef notNil ifTrue:[
|
|
|
216 |
backRef == #none ifFalse:[
|
|
|
217 |
s nextPutAll:'<a NOPRINT HREF="TOP.html" action="html:' , self name , ' ' , backRef , '"> <IMG SRC="../icons/DocsUpArrow.gif" ALT="back"></A>'.
|
|
|
218 |
]
|
|
|
219 |
] ifFalse:[
|
|
|
220 |
s nextPutAll:'<a NOPRINT HREF="TOP.html"> <IMG SRC="../icons/DocsUpArrow.gif" ALT="back"></A>'.
|
|
|
221 |
].
|
|
|
222 |
backRef ~~ #none ifTrue:[
|
|
|
223 |
s nextPutAll:'<hr>
|
|
|
224 |
'.
|
|
|
225 |
].
|
|
|
226 |
|
|
|
227 |
s nextPutAll:'
|
|
|
228 |
<h1>
|
|
|
229 |
'.
|
|
|
230 |
s nextPutAll:title; cr.
|
|
|
231 |
s nextPutAll:'
|
|
|
232 |
</h1>
|
|
|
233 |
<ul>
|
|
|
234 |
'.
|
|
|
235 |
|
|
|
236 |
classNames do:[:nm |
|
|
|
237 |
s nextPutAll:'<li><a href="../misc/onlyInSTX2.html" action="html:' , self name ,' htmlDocOf:' , nm , '">' , nm , '</A>';cr
|
|
|
238 |
].
|
|
|
239 |
|
|
|
240 |
s nextPutAll:'
|
|
|
241 |
</ul>
|
|
|
242 |
</body>
|
|
|
243 |
</html>
|
|
|
244 |
'.
|
|
|
245 |
|
|
|
246 |
^ s contents
|
|
|
247 |
|
|
|
248 |
"Created: 23.4.1996 / 15:31:55 / cg"
|
|
|
249 |
"Modified: 7.9.1996 / 20:00:10 / cg"
|
|
|
250 |
!
|
|
|
251 |
|
|
|
252 |
htmlClassesListOfCategory:category
|
|
|
253 |
|classes|
|
|
|
254 |
|
|
|
255 |
classes := Smalltalk allClasses
|
|
|
256 |
select:[:cls | cls category = category].
|
|
|
257 |
|
|
|
258 |
^ self
|
|
|
259 |
htmlClasses:classes
|
|
|
260 |
title:('Classes in: ' , category)
|
|
|
261 |
backTo:nil
|
|
|
262 |
|
|
|
263 |
"Created: 22.4.1996 / 20:03:31 / cg"
|
|
|
264 |
"Modified: 23.4.1996 / 15:42:17 / cg"
|
|
|
265 |
!
|
|
|
266 |
|
|
|
267 |
htmlClassesListOfCategory:category backTo:backRef
|
|
|
268 |
|classes|
|
|
|
269 |
|
|
|
270 |
classes := Smalltalk allClasses
|
|
|
271 |
select:[:cls | cls category = category].
|
|
|
272 |
|
|
|
273 |
^ self
|
|
|
274 |
htmlClasses:classes title:('Classes in: ' , category)
|
|
|
275 |
backTo:backRef
|
|
|
276 |
|
|
|
277 |
"Modified: 23.4.1996 / 15:31:38 / cg"
|
|
|
278 |
"Created: 23.4.1996 / 15:39:39 / cg"
|
|
|
279 |
!
|
|
|
280 |
|
|
|
281 |
htmlDocOf:aClass
|
|
|
282 |
^ self htmlDocOf:aClass back:nil backRef:nil
|
|
|
283 |
|
|
|
284 |
"
|
|
|
285 |
self htmlDocOf:PostscriptPrinterStream
|
|
|
286 |
"
|
|
|
287 |
|
|
|
288 |
"Modified: 24.4.1996 / 15:03:06 / cg"
|
|
|
289 |
!
|
|
|
290 |
|
|
|
291 |
htmlDocOf:aClass back:backCmd
|
|
|
292 |
^ self htmlDocOf:aClass back:backCmd backRef:nil
|
|
|
293 |
|
|
|
294 |
"Modified: 24.4.1996 / 15:03:30 / cg"
|
|
|
295 |
!
|
|
|
296 |
|
|
|
297 |
htmlDocOf:aClass back:backCmd backRef:backRef
|
|
|
298 |
|supers s indent m docu examples firstIndent firstNonEmpty
|
|
|
299 |
collectionOfCategories collectionOfClassCategories
|
|
|
300 |
revInfo pckgInfo subs refLines srchIdx l idx demoLines
|
|
|
301 |
backHRef authorLines first wasLoaded didLoadBin|
|
|
|
302 |
|
|
|
303 |
(wasLoaded := aClass isLoaded) ifFalse:[
|
|
|
304 |
"/ load it - but not a binary
|
|
|
305 |
didLoadBin := Smalltalk loadBinaries.
|
|
|
306 |
Smalltalk loadBinaries:false.
|
|
|
307 |
aClass autoload.
|
|
|
308 |
didLoadBin ifTrue:[Smalltalk loadBinaries:true].
|
|
|
309 |
].
|
|
|
310 |
|
|
|
311 |
"/
|
|
|
312 |
"/ extract documentation or comment, if there is any
|
|
|
313 |
"/
|
|
|
314 |
m := aClass class compiledMethodAt:#documentation.
|
|
|
315 |
m notNil ifTrue:[
|
|
|
316 |
docu := m comment.
|
|
|
317 |
] ifFalse:[
|
|
|
318 |
"try comment"
|
|
|
319 |
docu := aClass comment.
|
|
|
320 |
].
|
|
|
321 |
docu notNil ifTrue:[
|
|
|
322 |
docu isEmpty ifTrue:[
|
|
|
323 |
docu := nil
|
|
|
324 |
].
|
|
|
325 |
].
|
|
|
326 |
docu notNil ifTrue:[
|
|
|
327 |
docu := (docu copy
|
|
|
328 |
replChar:$< withString:'<')
|
|
|
329 |
replChar:$> withString:'>'.
|
|
|
330 |
|
|
|
331 |
docu := docu asStringCollection.
|
|
|
332 |
|
|
|
333 |
"/
|
|
|
334 |
"/ search for a [see also:] line
|
|
|
335 |
"/
|
|
|
336 |
refLines := self extractSpecial:'[see also:]' from:docu.
|
|
|
337 |
|
|
|
338 |
"/
|
|
|
339 |
"/ search for a [start with:] line
|
|
|
340 |
"/
|
|
|
341 |
demoLines := self extractSpecial:'[start with:]' from:docu.
|
|
|
342 |
|
|
|
343 |
"/
|
|
|
344 |
"/ search for a [author:] line
|
|
|
345 |
"/
|
|
|
346 |
authorLines := self extractSpecial:'[author:]' from:docu.
|
|
|
347 |
|
|
|
348 |
"/
|
|
|
349 |
"/ strip off empty lines
|
|
|
350 |
"/
|
|
|
351 |
[(docu at:1) size == 0] whileTrue:[
|
|
|
352 |
docu removeIndex:1
|
|
|
353 |
].
|
|
|
354 |
[(docu at:docu size) size == 0] whileTrue:[
|
|
|
355 |
docu removeIndex:(docu size)
|
|
|
356 |
].
|
|
|
357 |
|
|
|
358 |
docu notEmpty ifTrue:[
|
|
|
359 |
firstIndent := docu first leftIndent.
|
|
|
360 |
firstIndent > 0 ifTrue:[
|
|
|
361 |
docu := docu collect:[:line |
|
|
|
362 |
line leftIndent >= firstIndent ifTrue:[
|
|
|
363 |
line copyFrom:firstIndent.
|
|
|
364 |
] ifFalse:[
|
|
|
365 |
line
|
|
|
366 |
]
|
|
|
367 |
].
|
|
|
368 |
].
|
|
|
369 |
firstNonEmpty := docu findFirst:[:line | line notEmpty].
|
|
|
370 |
firstNonEmpty > 1 ifTrue:[
|
|
|
371 |
docu := docu copyFrom:firstNonEmpty
|
|
|
372 |
]
|
|
|
373 |
].
|
|
|
374 |
docu := docu asString.
|
|
|
375 |
].
|
|
|
376 |
|
|
|
377 |
refLines notNil ifTrue:[
|
|
|
378 |
refLines := refLines collect:[:l |
|
|
|
379 |
|t|
|
|
|
380 |
|
|
|
381 |
((t := l withoutSeparators) startsWith:'(') ifTrue:[
|
|
|
382 |
t
|
|
|
383 |
] ifFalse:[
|
|
|
384 |
l asCollectionOfWords
|
|
|
385 |
]
|
|
|
386 |
].
|
|
|
387 |
].
|
|
|
388 |
|
|
|
389 |
"/
|
|
|
390 |
"/ extract examples if there are any
|
|
|
391 |
"/
|
|
|
392 |
m := aClass class compiledMethodAt:#examples.
|
|
|
393 |
m notNil ifTrue:[
|
|
|
394 |
examples := m comment.
|
|
|
395 |
examples notNil ifTrue:[
|
|
|
396 |
examples isEmpty ifTrue:[
|
|
|
397 |
examples := nil
|
|
|
398 |
].
|
|
|
399 |
].
|
|
|
400 |
examples notNil ifTrue:[
|
|
|
401 |
examples := (examples copy
|
|
|
402 |
replChar:$< withString:'<')
|
|
|
403 |
replChar:$> withString:'>'.
|
|
|
404 |
|
|
|
405 |
examples := examples asStringCollection.
|
|
|
406 |
|
|
|
407 |
"/
|
|
|
408 |
"/ strip off empty lines
|
|
|
409 |
"/
|
|
|
410 |
[examples first size == 0] whileTrue:[
|
|
|
411 |
examples removeIndex:1
|
|
|
412 |
].
|
|
|
413 |
[examples last size == 0] whileTrue:[
|
|
|
414 |
examples removeIndex:(examples size)
|
|
|
415 |
].
|
|
|
416 |
|
|
|
417 |
examples notEmpty ifTrue:[
|
|
|
418 |
firstIndent := examples first withTabsExpanded leftIndent.
|
|
|
419 |
firstIndent > 0 ifTrue:[
|
|
|
420 |
examples := examples collect:[:line |
|
|
|
421 |
|l|
|
|
|
422 |
|
|
|
423 |
l := line withTabsExpanded.
|
|
|
424 |
l leftIndent >= firstIndent ifTrue:[
|
|
|
425 |
l copyFrom:firstIndent.
|
|
|
426 |
] ifFalse:[
|
|
|
427 |
l
|
|
|
428 |
]
|
|
|
429 |
].
|
|
|
430 |
].
|
|
|
431 |
firstNonEmpty := examples findFirst:[:line | line notEmpty].
|
|
|
432 |
firstNonEmpty > 1 ifTrue:[
|
|
|
433 |
examples := examples copyFrom:firstNonEmpty
|
|
|
434 |
]
|
|
|
435 |
].
|
|
|
436 |
]
|
|
|
437 |
].
|
|
|
438 |
|
|
|
439 |
collectionOfClassCategories := aClass class categories.
|
|
|
440 |
collectionOfClassCategories size > 0 ifTrue:[
|
|
|
441 |
collectionOfClassCategories := collectionOfClassCategories asOrderedCollection.
|
|
|
442 |
collectionOfClassCategories remove:'documentation' ifAbsent:nil.
|
|
|
443 |
].
|
|
|
444 |
collectionOfCategories := aClass categories.
|
|
|
445 |
collectionOfCategories size > 0 ifTrue:[
|
|
|
446 |
collectionOfCategories := collectionOfCategories asOrderedCollection.
|
|
|
447 |
].
|
|
|
448 |
|
|
|
449 |
(aClass == Autoload or:[aClass == Object]) ifTrue:[
|
|
|
450 |
subs := #()
|
|
|
451 |
] ifFalse:[
|
|
|
452 |
subs := aClass subclasses
|
|
|
453 |
asOrderedCollection sort:[:a :b | a name < b name].
|
|
|
454 |
].
|
|
|
455 |
|
|
|
456 |
s := '' writeStream.
|
|
|
457 |
|
|
|
458 |
s nextPutAll:'<html>'; cr.
|
|
|
459 |
s nextPutAll:'<head>'; cr.
|
|
|
460 |
s nextPutAll:'<title>'; cr.
|
|
|
461 |
s nextPutAll:'Class: '; nextPutAll:(aClass name); cr.
|
|
|
462 |
s nextPutAll:'</title>'; cr.
|
|
|
463 |
s nextPutAll:'</head>'; cr.
|
|
|
464 |
|
|
|
465 |
s nextPutAll:'<body>'; cr.
|
|
|
466 |
|
|
|
467 |
backRef isNil ifTrue:[
|
|
|
468 |
backHRef := 'TOP.html'
|
|
|
469 |
] ifFalse:[
|
|
|
470 |
backHRef := backRef
|
|
|
471 |
].
|
|
|
472 |
backCmd notNil ifTrue:[
|
|
|
473 |
s nextPutAll:'<a NOPRINT HREF="' , backHRef , '" action="html:' , self name , ' ' , backCmd , '"> <IMG SRC="../icons/DocsUpArrow.gif" ALT="back"></A>'.
|
|
|
474 |
s nextPutAll:'<hr>'; cr.
|
|
|
475 |
] ifFalse:[
|
|
|
476 |
backHRef ~~ #none ifTrue:[
|
|
|
477 |
s nextPutAll:'<a NOPRINT HREF="' , backHRef , '"> <IMG SRC="../icons/DocsUpArrow.gif" ALT="back"></A>';cr.
|
|
|
478 |
s nextPutAll:'<hr>'; cr.
|
|
|
479 |
]
|
|
|
480 |
].
|
|
|
481 |
|
|
|
482 |
s nextPutAll:'<h1>'; cr.
|
|
|
483 |
s nextPutAll:'Class: ';
|
|
|
484 |
nextPutAll:'<a type="example" action="SystemBrowser openInClass:' , aClass name , '">';
|
|
|
485 |
nextPutAll:(aClass name); nextPutAll:'</a>'; cr.
|
|
|
486 |
s nextPutAll:'</h1>'; cr.
|
|
|
487 |
|
|
|
488 |
"/
|
|
|
489 |
"/ index
|
|
|
490 |
"/
|
|
|
491 |
"/ s nextPutAll:'Index:'; cr.
|
|
|
492 |
s nextPutAll:'<ul>'; cr.
|
|
|
493 |
s nextPutAll:'<li><a href="#INHERITANCE" name="I_INHERITANCE">Inheritance</a>'; cr.
|
|
|
494 |
docu notNil ifTrue:[
|
|
|
495 |
s nextPutAll:'<li><a href="#DESCRIPTION" name="I_DESCRIPTION">Description</a>'; cr.
|
|
|
496 |
].
|
|
|
497 |
|
|
|
498 |
refLines notNil ifTrue:[
|
|
|
499 |
s nextPutAll:'<li><a href="#SEEALSO" name="I_SEEALSO">Related information</a>'; cr.
|
|
|
500 |
].
|
|
|
501 |
|
|
|
502 |
"/ s nextPutAll:'<li><a href="#INSTANCEVARIABLES" name="I_INSTANCEVARIABLES">Instance variables</a>'; cr.
|
|
|
503 |
"/ s nextPutAll:'<li><a href="#CLASSVARIABLES" name="I_CLASSVARIABLES">Class variables</a>'; cr.
|
|
|
504 |
|
|
|
505 |
collectionOfClassCategories size > 0 ifTrue:[
|
|
|
506 |
s nextPutAll:'<li><a href="#CLASSPROTOCOL" name="I_CLASSPROTOCOL">Class protocol</a>'; cr.
|
|
|
507 |
s nextPutAll:'<ul>'; cr.
|
|
|
508 |
collectionOfClassCategories sort do:[:cat |
|
|
|
509 |
s nextPutAll:'<li><a name="I_' , aClass class name , '_category_' , cat , '"' ,
|
|
|
510 |
' href="#' , aClass class name , '_category_' , cat ,
|
|
|
511 |
'">' , cat , '</a> '; cr.
|
|
|
512 |
].
|
|
|
513 |
s nextPutAll:'</ul>'; cr.
|
|
|
514 |
].
|
|
|
515 |
collectionOfCategories size > 0 ifTrue:[
|
|
|
516 |
s nextPutAll:'<li><a href="#INSTANCEPROTOCOL" name="I_INSTANCEPROTOCOL">Instance protocol</a>'; cr.
|
|
|
517 |
s nextPutAll:'<ul>'; cr.
|
|
|
518 |
collectionOfCategories sort do:[:cat |
|
|
|
519 |
s nextPutAll:'<li><a name="I_' , aClass name , '_category_' , cat , '"' ,
|
|
|
520 |
' href="#' , aClass name , '_category_' , cat ,
|
|
|
521 |
'">' , cat , '</a> '; cr.
|
|
|
522 |
].
|
|
|
523 |
s nextPutAll:'</ul>'; cr.
|
|
|
524 |
].
|
|
|
525 |
|
|
|
526 |
(aClass == Object or:[aClass == Autoload]) ifTrue:[
|
|
|
527 |
s nextPutAll:'<li><a href="#SUBCLASSES" name="I_SUBCLASSES">Subclasses</a>'; cr.
|
|
|
528 |
].
|
|
|
529 |
demoLines notNil ifTrue:[
|
|
|
530 |
s nextPutAll:'<li><a href="#DEMOSTARTUP" name="I_DEMOSTARTUP">Demonstration</a>'; cr.
|
|
|
531 |
].
|
|
|
532 |
examples notNil ifTrue:[
|
|
|
533 |
s nextPutAll:'<li><a href="#EXAMPLES" name="I_EXAMPLES">Examples</a>'; cr.
|
|
|
534 |
].
|
|
|
535 |
s nextPutAll:'</ul>'; cr.
|
|
|
536 |
s nextPutAll:'<hr>'; cr.
|
|
|
537 |
|
|
|
538 |
|
|
|
539 |
"/
|
|
|
540 |
"/ hierarchy
|
|
|
541 |
"/
|
|
|
542 |
s nextPutAll:'<h2><a name="INHERITANCE" href="#I_INHERITANCE">Inheritance:</A></h2>'; cr.
|
|
|
543 |
s nextPutAll:'<pre>'; cr.
|
|
|
544 |
indent := 3.
|
|
|
545 |
first := true.
|
|
|
546 |
supers := aClass allSuperclasses.
|
|
|
547 |
(supers notNil) ifTrue:[
|
|
|
548 |
supers reverse do:[:cls |
|
|
|
549 |
|nm|
|
|
|
550 |
|
|
|
551 |
nm := cls name.
|
|
|
552 |
first ifFalse:[
|
|
|
553 |
s spaces:indent; nextPutAll:'|'; cr.
|
|
|
554 |
s spaces:indent; nextPutAll:'+--'.
|
|
|
555 |
indent := indent + 3.
|
|
|
556 |
] ifTrue:[
|
|
|
557 |
s spaces:indent
|
|
|
558 |
].
|
|
|
559 |
first := false.
|
|
|
560 |
|
|
|
561 |
s nextPutAll:'<a href="../misc/onlyInSTX2.html" action="html:' , self name , ' htmlDocOf:' , nm , '">' , nm , '</A>';cr.
|
|
|
562 |
].
|
|
|
563 |
s spaces:indent; nextPutAll:'|'; cr.
|
|
|
564 |
s spaces:indent.
|
|
|
565 |
s nextPutAll:'+--<B>'; nextPutAll:aClass name; nextPutAll:'</B>'; cr.
|
|
|
566 |
indent := indent + 3.
|
|
|
567 |
] ifFalse:[
|
|
|
568 |
s spaces:indent; nextPutAll:'nil'; cr.
|
|
|
569 |
s spaces:indent; nextPutAll:'|'; cr.
|
|
|
570 |
s spaces:indent; nextPutAll:'+--<B>'; nextPutAll:aClass name; nextPutAll:'</B>'; cr.
|
|
|
571 |
aClass ~~ Object ifTrue:[
|
|
|
572 |
s cr.
|
|
|
573 |
s nextPutAll:' <B>This class inherits NOTHING - most messages will lead into doesNotUnderstand:</B>'; cr
|
|
|
574 |
].
|
|
|
575 |
indent := indent + 3.
|
|
|
576 |
].
|
|
|
577 |
|
|
|
578 |
subs notEmpty ifTrue:[
|
|
|
579 |
subs do:[:aSubclass |
|
|
|
580 |
|nm|
|
|
|
581 |
|
|
|
582 |
nm := aSubclass name.
|
|
|
583 |
s spaces:indent; nextPutAll:'|'; cr.
|
|
|
584 |
s spaces:indent; nextPutAll:'+--'.
|
|
|
585 |
s nextPutAll:'<a href="../misc/onlyInSTX2.html" action="html:' , self name , ' htmlDocOf:' , nm , '">' , nm , '</A>';cr.
|
|
|
586 |
]
|
|
|
587 |
] ifFalse:[
|
|
|
588 |
aClass == Object ifTrue:[
|
|
|
589 |
s spaces:indent; nextPutAll:'|'; cr.
|
|
|
590 |
s spaces:indent; nextPutAll:'+-- ... almost every other class ...'; cr
|
|
|
591 |
]
|
|
|
592 |
].
|
|
|
593 |
|
|
|
594 |
|
|
|
595 |
s nextPutAll:'</pre>'; cr.
|
|
|
596 |
s nextPutAll:'<hr>'; cr.
|
|
|
597 |
|
|
|
598 |
"/
|
|
|
599 |
"/ category, version & package
|
|
|
600 |
"/
|
|
|
601 |
s nextPutAll:'<dl>'; cr.
|
|
|
602 |
s nextPutAll:'<dt><a name="CATEGORY"><b>Category:</b></A>'; cr.
|
|
|
603 |
s nextPutAll:'<dd><b>', aClass category , '</b>'; cr.
|
|
|
604 |
s nextPutAll:'</dl>'; cr.
|
|
|
605 |
|
|
|
606 |
revInfo := aClass revisionInfo.
|
|
|
607 |
pckgInfo := aClass packageSourceCodeInfo.
|
|
|
608 |
|
|
|
609 |
s nextPutAll:'<dl>'; cr.
|
|
|
610 |
s nextPutAll:'<dt><a name="VERSION"><b>Version:</b></A>'; cr.
|
|
|
611 |
|
|
|
612 |
(revInfo isNil and:[pckgInfo isNil]) ifTrue:[
|
|
|
613 |
s nextPutAll:'<dd>no revision info'; cr.
|
|
|
614 |
] ifFalse:[
|
|
|
615 |
revInfo isNil ifTrue:[revInfo := IdentityDictionary new].
|
|
|
616 |
pckgInfo isNil ifTrue:[pckgInfo := IdentityDictionary new].
|
|
|
617 |
|
|
|
618 |
s nextPutAll:'<dd>rev: <b>'; cr.
|
|
|
619 |
s nextPutAll:(revInfo at:#revision ifAbsent:'?'); cr.
|
|
|
620 |
s nextPutAll:'</b> date: <b>' , (revInfo at:#date ifAbsent:'')
|
|
|
621 |
, ' ', (revInfo at:#time ifAbsent:'') , '</b>'; cr.
|
|
|
622 |
s nextPutAll:'<dd>user: <b>' , (revInfo at:#user ifAbsent:'?') , '</b>';cr.
|
|
|
623 |
s nextPutAll:'<dd>file: <b>' , (revInfo at:#fileName ifAbsent:'?').
|
|
|
624 |
s nextPutAll:'</b> directory: <b>' , (pckgInfo at:#directory ifAbsent:'?') , '</b>'; cr.
|
|
|
625 |
|
|
|
626 |
s nextPutAll:'<dd>module: <b>' , (pckgInfo at:#module ifAbsent:'?')
|
|
|
627 |
, '</b> classLibrary: <b>' , (pckgInfo at:#library ifAbsent:'?') , '</b>';cr.
|
|
|
628 |
|
|
|
629 |
].
|
|
|
630 |
s nextPutAll:'</dl>'; cr.
|
|
|
631 |
|
|
|
632 |
authorLines notNil ifTrue:[
|
|
|
633 |
s nextPutAll:'<dl>'; cr.
|
|
|
634 |
s nextPutAll:'<dt><a name="AUTHOR"><b>Author:</b></A>'; cr.
|
|
|
635 |
authorLines do:[:l|
|
|
|
636 |
s nextPutAll:'<dd><b>', l , '</b>'; cr.
|
|
|
637 |
].
|
|
|
638 |
s nextPutAll:'</dl>'; cr.
|
|
|
639 |
].
|
|
|
640 |
|
|
|
641 |
s nextPutAll:'<hr>'; cr.
|
|
|
642 |
|
|
|
643 |
docu notNil ifTrue:[
|
|
|
644 |
s nextPutAll:'<h2><a name="DESCRIPTION" href="#I_DESCRIPTION">Description:</A></h2>'; cr.
|
|
|
645 |
s nextPutAll:'<BR>'; cr.
|
|
|
646 |
|
|
|
647 |
s nextPutAll:'<pre>'; cr.
|
|
|
648 |
s nextPutAll:docu;cr.
|
|
|
649 |
s nextPutAll:'</pre>'; cr.
|
|
|
650 |
s nextPutAll:'<hr>'; cr.
|
|
|
651 |
].
|
|
|
652 |
|
|
|
653 |
"/
|
|
|
654 |
"/ see also
|
|
|
655 |
"/
|
|
|
656 |
refLines notNil ifTrue:[
|
|
|
657 |
s nextPutAll:'<h2><a name="SEEALSO" href="#I_SEEALSO">Related information:</A></h2>'; cr.
|
|
|
658 |
s nextPutAll:'<pre>'; cr.
|
|
|
659 |
refLines do:[:l |
|
|
|
660 |
|nm href|
|
|
|
661 |
|
|
|
662 |
s nextPutAll:' '.
|
|
|
663 |
|
|
|
664 |
l isString ifTrue:[
|
|
|
665 |
nm := (l copyFrom:2 to:(l indexOf:$:)-1) withoutSpaces.
|
|
|
666 |
href := (l copyFrom:(l indexOf:$:)+1 to:(l size - 1)) withoutSpaces.
|
|
|
667 |
(href startsWith:'man:') ifTrue:[
|
|
|
668 |
href := (href copyFrom:5) withoutSpaces.
|
|
|
669 |
s nextPutAll:'<a href="../misc/onlyInSTX2.html" action="html:' , self name , ' manPageFor:''' , href , '''">[<I>' , nm , '</I>]</A>'.
|
|
|
670 |
] ifFalse:[
|
|
|
671 |
(href startsWith:'html:') ifTrue:[
|
|
|
672 |
href := (href copyFrom:6) withoutSpaces.
|
|
|
673 |
].
|
|
|
674 |
s nextPutAll:'<a href="../' , href , '">[<I>' , nm , '</I>]</a>'.
|
|
|
675 |
]
|
|
|
676 |
] ifFalse:[
|
|
|
677 |
l do:[:ref |
|
|
|
678 |
s nextPutAll:'<a href="../misc/onlyInSTX2.html" action="html:' , self name , ' htmlDocOf:' , ref , '">' , ref , '</A>'.
|
|
|
679 |
s nextPutAll:' '.
|
|
|
680 |
].
|
|
|
681 |
].
|
|
|
682 |
s cr.
|
|
|
683 |
].
|
|
|
684 |
s nextPutAll:'</pre>'; cr.
|
|
|
685 |
s nextPutAll:'<hr>'; cr.
|
|
|
686 |
].
|
|
|
687 |
|
|
|
688 |
|
|
|
689 |
"/
|
|
|
690 |
"/ inst & classVars
|
|
|
691 |
"/ to be added
|
|
|
692 |
|
|
|
693 |
|
|
|
694 |
"/
|
|
|
695 |
"/ protocol
|
|
|
696 |
"/
|
|
|
697 |
self printOutHTMLProtocolOf:aClass on:s.
|
|
|
698 |
|
|
|
699 |
"/
|
|
|
700 |
"/ subclasses (only for Object and Autoload)
|
|
|
701 |
"/
|
|
|
702 |
(aClass == Object or:[aClass == Autoload]) ifTrue:[
|
|
|
703 |
subs := aClass subclasses
|
|
|
704 |
asOrderedCollection sort:[:a :b | a name < b name].
|
|
|
705 |
|
|
|
706 |
s nextPutAll:'<h2><a name="SUBCLASSES" href="#I_SUBCLASSES">Subclasses (direct subclasses only):</A></h2>'; cr.
|
|
|
707 |
s nextPutAll:'<pre>'; cr.
|
|
|
708 |
subs do:[:cls |
|
|
|
709 |
|nm|
|
|
|
710 |
|
|
|
711 |
nm := cls name.
|
|
|
712 |
s nextPutAll:' '.
|
|
|
713 |
cls isLoaded ifFalse:[
|
|
|
714 |
s nextPutAll:'<a href="../misc/onlyInSTX2.html" action="html:' , nm , ' autoload. ',self name,' htmlDocOf:' , nm, '">' , nm , '</A>';cr
|
|
|
715 |
] ifTrue:[
|
|
|
716 |
s nextPutAll:'<a href="../misc/onlyInSTX2.html" action="html:',self name,' htmlDocOf:' , nm , '">' , nm , '</A>';cr
|
|
|
717 |
].
|
|
|
718 |
].
|
|
|
719 |
s nextPutAll:'</pre>'; cr.
|
|
|
720 |
s nextPutAll:'<hr>'; cr.
|
|
|
721 |
].
|
|
|
722 |
|
|
|
723 |
"/
|
|
|
724 |
"/ demonstration
|
|
|
725 |
"/
|
|
|
726 |
demoLines notNil ifTrue:[
|
|
|
727 |
s nextPutAll:'<h2><a name="DEMOSTARTUP" href="#I_DEMOSTARTUP">Demonstration:</A></h2>'; cr.
|
|
|
728 |
demoLines do:[:l |
|
|
|
729 |
s nextPutAll:'<a type="example">'; cr.
|
|
|
730 |
s nextPutAll:'<code><pre>'; cr.
|
|
|
731 |
s nextPutAll:' ' , l withoutSeparators; cr.
|
|
|
732 |
s nextPutAll:'</pre></code>'; cr.
|
|
|
733 |
s nextPutAll:'</a>'; cr.
|
|
|
734 |
s nextPutAll:'<br>'; cr.
|
|
|
735 |
].
|
|
|
736 |
s nextPutAll:'<hr>'; cr.
|
|
|
737 |
].
|
|
|
738 |
|
|
|
739 |
"/
|
|
|
740 |
"/ add examples if there are any
|
|
|
741 |
"/
|
|
|
742 |
examples notNil ifTrue:[
|
|
|
743 |
s nextPutAll:'<h2><a name="EXAMPLES" href="#I_EXAMPLES">Examples:</A></h2>'; cr.
|
|
|
744 |
s nextPutAll:'<BR>'; cr.
|
|
|
745 |
s nextPutAll:'<code><pre>'; cr.
|
|
|
746 |
examples do:[:line |
|
|
|
747 |
line withoutSeparators = '[exBegin]' ifTrue:[
|
|
|
748 |
s nextPutAll:'<a type="example">'; cr.
|
|
|
749 |
] ifFalse:[
|
|
|
750 |
line withoutSeparators = '[exEnd]' ifTrue:[
|
|
|
751 |
s nextPutAll:'</a>'; cr.
|
|
|
752 |
] ifFalse:[
|
|
|
753 |
s nextPutAll:line; cr
|
|
|
754 |
]
|
|
|
755 |
].
|
|
|
756 |
].
|
|
|
757 |
s nextPutAll:'</pre></code>'; cr.
|
|
|
758 |
s nextPutAll:'<hr>'; cr.
|
|
|
759 |
].
|
|
|
760 |
|
|
|
761 |
|
|
|
762 |
s nextPutAll:'</body>'; cr.
|
|
|
763 |
s nextPutAll:'</html>'; cr.
|
|
|
764 |
|
|
|
765 |
wasLoaded ifFalse:[
|
|
|
766 |
aClass unload
|
|
|
767 |
].
|
|
|
768 |
|
|
|
769 |
^ s contents
|
|
|
770 |
|
|
|
771 |
"
|
|
|
772 |
self htmlDocOf:Object
|
|
|
773 |
self htmlDocOf:Array
|
|
|
774 |
self htmlDocOf:Filename
|
|
|
775 |
self htmlDocOf:Block
|
|
|
776 |
"
|
|
|
777 |
|
|
|
778 |
"Created: 24.4.1996 / 15:01:59 / cg"
|
|
|
779 |
"Modified: 12.9.1996 / 08:05:38 / cg"
|
|
|
780 |
!
|
|
|
781 |
|
|
|
782 |
htmlDocOf:aClass backRef:backRef
|
|
|
783 |
^ self htmlDocOf:aClass back:nil backRef:backRef
|
|
|
784 |
|
|
|
785 |
"Modified: 24.4.1996 / 15:02:52 / cg"
|
|
|
786 |
"Created: 24.4.1996 / 15:03:25 / cg"
|
|
|
787 |
!
|
|
|
788 |
|
|
|
789 |
htmlDocOfImplementorsOf:selector
|
|
|
790 |
|classNames sel s|
|
|
|
791 |
|
|
|
792 |
sel := (selector copy
|
|
|
793 |
replChar:$< withString:'<')
|
|
|
794 |
replChar:$> withString:'>'.
|
|
|
795 |
|
|
|
796 |
s := '' writeStream.
|
|
|
797 |
|
|
|
798 |
s nextPutAll:'<html>'; cr.
|
|
|
799 |
s nextPutAll:'<head>'; cr.
|
|
|
800 |
s nextPutAll:'<title>'; cr.
|
|
|
801 |
s nextPutAll:sel; cr.
|
|
|
802 |
s nextPutAll:'</title>'; cr.
|
|
|
803 |
s nextPutAll:'</head>'; cr.
|
|
|
804 |
|
|
|
805 |
s nextPutAll:'<body>'; cr.
|
|
|
806 |
s nextPutAll:'<a NOPRINT HREF="TOP.html"> <IMG SRC="../icons/DocsUpArrow.gif" ALT="back"></A>';cr.
|
|
|
807 |
s nextPutAll:'<hr>'; cr.
|
|
|
808 |
s nextPutAll:'<h1>'; cr.
|
|
|
809 |
s nextPutAll:sel ; cr.
|
|
|
810 |
s nextPutAll:'</h1>'; cr.
|
|
|
811 |
|
|
|
812 |
s nextPutAll:'<dl>'; cr.
|
|
|
813 |
|
|
|
814 |
sel := selector asSymbol.
|
|
|
815 |
Smalltalk allClassesDo:[:cls |
|
|
|
816 |
(cls implements:sel) ifTrue:[
|
|
|
817 |
self printOutHTMLMethodProtocol:(cls compiledMethodAt:sel)
|
|
|
818 |
on:s showClassName:true classRef:true.
|
|
|
819 |
s nextPutAll:'<p>'; cr.
|
|
|
820 |
]
|
|
|
821 |
].
|
|
|
822 |
|
|
|
823 |
s nextPutAll:'</dl>'; cr.
|
|
|
824 |
|
|
|
825 |
s nextPutAll:'</body>'; cr.
|
|
|
826 |
s nextPutAll:'</html>'; cr.
|
|
|
827 |
|
|
|
828 |
^ s contents
|
|
|
829 |
|
|
|
830 |
"Created: 22.4.1996 / 20:03:31 / cg"
|
|
|
831 |
"Modified: 7.9.1996 / 20:00:31 / cg"
|
|
|
832 |
!
|
|
|
833 |
|
|
|
834 |
htmlSelectorList
|
|
|
835 |
|selectors|
|
|
|
836 |
|
|
|
837 |
selectors := IdentitySet new.
|
|
|
838 |
Smalltalk allClassesDo:[:cls |
|
|
|
839 |
selectors addAll:cls methodDictionary keys.
|
|
|
840 |
].
|
|
|
841 |
selectors := selectors asOrderedCollection sort.
|
|
|
842 |
|
|
|
843 |
^ self htmlSelectors:selectors title:('All selectors:').
|
|
|
844 |
|
|
|
845 |
"
|
|
|
846 |
self htmlSelectorList
|
|
|
847 |
"
|
|
|
848 |
|
|
|
849 |
"Modified: 22.4.1996 / 12:48:45 / cg"
|
|
|
850 |
"Created: 22.4.1996 / 20:03:31 / cg"
|
|
|
851 |
"Modified: 5.6.1996 / 12:27:09 / stefan"
|
|
|
852 |
!
|
|
|
853 |
|
|
|
854 |
htmlSelectorListMatching:pattern
|
|
|
855 |
|selectors|
|
|
|
856 |
|
|
|
857 |
selectors := IdentitySet new.
|
|
|
858 |
Smalltalk allClassesDo:[:cls |
|
|
|
859 |
cls methodDictionary keysDo:[:sel |
|
|
|
860 |
(pattern match:sel) ifTrue:[
|
|
|
861 |
selectors add:sel.
|
|
|
862 |
]
|
|
|
863 |
]
|
|
|
864 |
].
|
|
|
865 |
selectors := selectors asOrderedCollection sort.
|
|
|
866 |
|
|
|
867 |
^ self htmlSelectors:selectors title:('Selectors matching ''' , pattern , ''':').
|
|
|
868 |
|
|
|
869 |
"
|
|
|
870 |
self htmlSelectorListMatching:'*do*'
|
|
|
871 |
"
|
|
|
872 |
|
|
|
873 |
"Modified: 22.4.1996 / 17:11:56 / cg"
|
|
|
874 |
"Created: 22.4.1996 / 20:03:31 / cg"
|
|
|
875 |
"Modified: 5.6.1996 / 12:29:27 / stefan"
|
|
|
876 |
!
|
|
|
877 |
|
|
|
878 |
htmlSelectorListPrefix:prefix
|
|
|
879 |
|selectors|
|
|
|
880 |
|
|
|
881 |
selectors := IdentitySet new.
|
|
|
882 |
Smalltalk allClassesDo:[:cls |
|
|
|
883 |
cls methodDictionary keysDo:[:sel |
|
|
|
884 |
(sel startsWith:prefix) ifTrue:[
|
|
|
885 |
selectors add:sel.
|
|
|
886 |
]
|
|
|
887 |
]
|
|
|
888 |
].
|
|
|
889 |
selectors := selectors asOrderedCollection sort.
|
|
|
890 |
|
|
|
891 |
^ self htmlSelectors:selectors title:('Selectors starting with ''' , prefix asString , ''':').
|
|
|
892 |
|
|
|
893 |
"
|
|
|
894 |
self htmlSelectorListPrefix:'a'
|
|
|
895 |
"
|
|
|
896 |
|
|
|
897 |
"Modified: 22.4.1996 / 19:57:50 / cg"
|
|
|
898 |
"Created: 22.4.1996 / 20:03:31 / cg"
|
|
|
899 |
"Modified: 5.6.1996 / 12:31:13 / stefan"
|
|
|
900 |
!
|
|
|
901 |
|
|
|
902 |
htmlSelectors:selectors title:title
|
|
|
903 |
|classNames s|
|
|
|
904 |
|
|
|
905 |
s := '' writeStream.
|
|
|
906 |
|
|
|
907 |
s nextPutAll:'<html>'; cr.
|
|
|
908 |
s nextPutAll:'<head>'; cr.
|
|
|
909 |
s nextPutAll:'<title>'; cr.
|
|
|
910 |
s nextPutAll:title; cr.
|
|
|
911 |
s nextPutAll:'</title>'; cr.
|
|
|
912 |
s nextPutAll:'</head>'; cr.
|
|
|
913 |
|
|
|
914 |
s nextPutAll:'<body>'; cr.
|
|
|
915 |
s nextPutAll:'<a NOPRINT HREF="TOP.html"> <IMG SRC="../icons/DocsUpArrow.gif" ALT="back"></A>';cr.
|
|
|
916 |
s nextPutAll:'<hr>'; cr.
|
|
|
917 |
s nextPutAll:'<h1>'; cr.
|
|
|
918 |
s nextPutAll:title; cr.
|
|
|
919 |
s nextPutAll:'</h1>'; cr.
|
|
|
920 |
|
|
|
921 |
s nextPutAll:'<ul>'; cr.
|
|
|
922 |
|
|
|
923 |
selectors do:[:sel |
|
|
|
924 |
|nm|
|
|
|
925 |
|
|
|
926 |
nm := (sel copy replChar:$< withString:'<')
|
|
|
927 |
replChar:$> withString:'>'.
|
|
|
928 |
s nextPutAll:'<li><a href="../misc/onlyInSTX2.html" action="html:',self name,' htmlDocOfImplementorsOf:''' , nm , '''">' , nm , '</A>';cr
|
|
|
929 |
].
|
|
|
930 |
|
|
|
931 |
s nextPutAll:'</ul>'; cr.
|
|
|
932 |
|
|
|
933 |
s nextPutAll:'</body>'; cr.
|
|
|
934 |
s nextPutAll:'</html>'; cr.
|
|
|
935 |
|
|
|
936 |
^ s contents
|
|
|
937 |
|
|
|
938 |
"Created: 22.4.1996 / 20:03:31 / cg"
|
|
|
939 |
"Modified: 7.9.1996 / 20:00:34 / cg"
|
|
|
940 |
!
|
|
|
941 |
|
|
|
942 |
manPageFor:aCommand
|
|
|
943 |
"q&d hack to convert man output to html"
|
|
|
944 |
|
|
|
945 |
^ self
|
|
|
946 |
manPageFor:aCommand
|
|
|
947 |
inSection:nil
|
|
|
948 |
|
|
|
949 |
"Modified: 9.9.1996 / 17:45:29 / cg"
|
|
|
950 |
!
|
|
|
951 |
|
|
|
952 |
manPageFor:aCommand inSection:sectionOrNil
|
|
|
953 |
"q&d hack to convert man output to html"
|
|
|
954 |
|
|
|
955 |
|manCmd|
|
|
|
956 |
|
|
|
957 |
sectionOrNil isNil ifTrue:[
|
|
|
958 |
manCmd := 'man ' , aCommand
|
|
|
959 |
] ifFalse:[
|
|
|
960 |
manCmd := 'man ' , sectionOrNil printString , ' ' , aCommand
|
|
|
961 |
].
|
|
|
962 |
^ self
|
|
|
963 |
manPageFor:aCommand
|
|
|
964 |
manCommand:manCmd.
|
|
|
965 |
|
|
|
966 |
"Created: 9.9.1996 / 17:45:08 / cg"
|
|
|
967 |
"Modified: 9.9.1996 / 17:48:29 / cg"
|
|
|
968 |
!
|
|
|
969 |
|
|
|
970 |
manPageFor:aCommand manCommand:manCommand
|
|
|
971 |
"q&d hack to convert man output to html"
|
|
|
972 |
|
|
|
973 |
|s t outStream state ch keep|
|
|
|
974 |
|
|
|
975 |
s := PipeStream readingFrom:manCommand.
|
|
|
976 |
s notNil ifTrue:[
|
|
|
977 |
outStream := '' writeStream.
|
|
|
978 |
state := nil.
|
|
|
979 |
keep := nil.
|
|
|
980 |
[s atEnd] whileFalse:[
|
|
|
981 |
ch := s next.
|
|
|
982 |
|
|
|
983 |
ch notNil ifTrue:[
|
|
|
984 |
state == nil ifTrue:[
|
|
|
985 |
ch == Character backspace ifTrue:[
|
|
|
986 |
state := #back
|
|
|
987 |
] ifFalse:[
|
|
|
988 |
keep notNil ifTrue:[
|
|
|
989 |
keep == $< ifTrue:[
|
|
|
990 |
outStream nextPutAll:'<'.
|
|
|
991 |
] ifFalse:[
|
|
|
992 |
outStream nextPut:keep.
|
|
|
993 |
].
|
|
|
994 |
].
|
|
|
995 |
keep := ch
|
|
|
996 |
]
|
|
|
997 |
] ifFalse:[
|
|
|
998 |
state == #back ifTrue:[
|
|
|
999 |
ch == keep ifTrue:[
|
|
|
1000 |
outStream nextPutAll:'<b>'.
|
|
|
1001 |
ch == $< ifTrue:[
|
|
|
1002 |
outStream nextPutAll:'<'.
|
|
|
1003 |
] ifFalse:[
|
|
|
1004 |
outStream nextPut:ch.
|
|
|
1005 |
].
|
|
|
1006 |
outStream nextPutAll:'</b>'.
|
|
|
1007 |
state := nil.
|
|
|
1008 |
keep := nil.
|
|
|
1009 |
] ifFalse:[
|
|
|
1010 |
ch == $_ ifTrue:[
|
|
|
1011 |
keep notNil ifTrue:[
|
|
|
1012 |
outStream nextPutAll:'<i>'.
|
|
|
1013 |
keep == $< ifTrue:[
|
|
|
1014 |
outStream nextPutAll:'<'.
|
|
|
1015 |
] ifFalse:[
|
|
|
1016 |
outStream nextPut:keep.
|
|
|
1017 |
].
|
|
|
1018 |
outStream nextPutAll:'</i>'.
|
|
|
1019 |
].
|
|
|
1020 |
state := nil.
|
|
|
1021 |
keep := nil.
|
|
|
1022 |
] ifFalse:[
|
|
|
1023 |
keep == $_ ifTrue:[
|
|
|
1024 |
outStream nextPutAll:'<i>'.
|
|
|
1025 |
ch == $< ifTrue:[
|
|
|
1026 |
outStream nextPutAll:'<'.
|
|
|
1027 |
] ifFalse:[
|
|
|
1028 |
outStream nextPut:ch.
|
|
|
1029 |
].
|
|
|
1030 |
outStream nextPutAll:'</i>'.
|
|
|
1031 |
state := nil.
|
|
|
1032 |
keep := nil.
|
|
|
1033 |
] ifFalse:[
|
|
|
1034 |
keep notNil ifTrue:[
|
|
|
1035 |
keep == $< ifTrue:[
|
|
|
1036 |
outStream nextPutAll:'<'.
|
|
|
1037 |
] ifFalse:[
|
|
|
1038 |
outStream nextPut:keep.
|
|
|
1039 |
].
|
|
|
1040 |
ch == $< ifTrue:[
|
|
|
1041 |
outStream nextPutAll:'<'.
|
|
|
1042 |
] ifFalse:[
|
|
|
1043 |
outStream nextPut:ch.
|
|
|
1044 |
]
|
|
|
1045 |
].
|
|
|
1046 |
state := nil.
|
|
|
1047 |
keep := nil.
|
|
|
1048 |
]
|
|
|
1049 |
]
|
|
|
1050 |
]
|
|
|
1051 |
]
|
|
|
1052 |
]
|
|
|
1053 |
]
|
|
|
1054 |
].
|
|
|
1055 |
|
|
|
1056 |
keep notNil ifTrue:[
|
|
|
1057 |
keep == $< ifTrue:[
|
|
|
1058 |
outStream nextPutAll:'<'.
|
|
|
1059 |
] ifFalse:[
|
|
|
1060 |
outStream nextPut:keep
|
|
|
1061 |
]
|
|
|
1062 |
].
|
|
|
1063 |
t := outStream contents.
|
|
|
1064 |
s shutDown.
|
|
|
1065 |
].
|
|
|
1066 |
|
|
|
1067 |
(t isNil or:[t isEmpty]) ifTrue:[
|
|
|
1068 |
^ '
|
|
|
1069 |
No manual page for "<CODE><B>' , aCommand , '</B></CODE>" available.
|
|
|
1070 |
<BR>
|
|
|
1071 |
(the failed command was: "<CODE>' , manCommand , '"</CODE>.)
|
|
|
1072 |
'.
|
|
|
1073 |
].
|
|
|
1074 |
|
|
|
1075 |
^ '
|
|
|
1076 |
<pre>
|
|
|
1077 |
' , t , '
|
|
|
1078 |
</pre>
|
|
|
1079 |
'
|
|
|
1080 |
|
|
|
1081 |
"
|
|
|
1082 |
self manPageFor:'cvs'
|
|
|
1083 |
"
|
|
|
1084 |
|
|
|
1085 |
"Modified: 28.6.1996 / 21:28:47 / stefan"
|
|
|
1086 |
"Created: 9.9.1996 / 17:43:16 / cg"
|
|
|
1087 |
"Modified: 9.9.1996 / 17:58:00 / cg"
|
|
|
1088 |
!
|
|
|
1089 |
|
|
|
1090 |
printOutHTMLCategoryProtocol:aCategory of:aClass on:aStream
|
|
|
1091 |
|any dict selectors methods|
|
|
|
1092 |
|
|
|
1093 |
dict := aClass methodDictionary.
|
|
|
1094 |
|
|
|
1095 |
dict notNil ifTrue:[
|
|
|
1096 |
any := false.
|
|
|
1097 |
dict do:[:aMethod |
|
|
|
1098 |
(aCategory = aMethod category) ifTrue:[
|
|
|
1099 |
any := true
|
|
|
1100 |
]
|
|
|
1101 |
].
|
|
|
1102 |
|
|
|
1103 |
any ifTrue:[
|
|
|
1104 |
aStream nextPutAll:'<a name="' , aClass name , '_category_' , aCategory ,
|
|
|
1105 |
'" href="#I_' , aClass name , '_category_' , aCategory ,
|
|
|
1106 |
'"><b>' , aCategory , '</b></A>'; cr.
|
|
|
1107 |
aStream nextPutAll:'<dl>'; cr.
|
|
|
1108 |
|
|
|
1109 |
selectors := dict keys asArray.
|
|
|
1110 |
methods := dict values.
|
|
|
1111 |
selectors sortWith:methods.
|
|
|
1112 |
methods do:[:aMethod |
|
|
|
1113 |
(aCategory = aMethod category) ifTrue:[
|
|
|
1114 |
ErrorSignal catch:[
|
|
|
1115 |
self printOutHTMLMethodProtocol:aMethod on:aStream.
|
|
|
1116 |
].
|
|
|
1117 |
aStream nextPutAll:'<p>'; cr.
|
|
|
1118 |
]
|
|
|
1119 |
].
|
|
|
1120 |
aStream nextPutAll:'</dl>'; cr.
|
|
|
1121 |
]
|
|
|
1122 |
]
|
|
|
1123 |
|
|
|
1124 |
"
|
|
|
1125 |
self printOutHTMLProtocolOf:Float on:Stdout
|
|
|
1126 |
"
|
|
|
1127 |
|
|
|
1128 |
"Created: 22.4.1996 / 20:03:30 / cg"
|
|
|
1129 |
"Modified: 30.4.1996 / 15:14:20 / cg"
|
|
|
1130 |
"Modified: 5.6.1996 / 13:41:27 / stefan"
|
|
|
1131 |
!
|
|
|
1132 |
|
|
|
1133 |
printOutHTMLMethodProtocol:aMethod on:aStream
|
|
|
1134 |
"given the source in aString, print the methods message specification
|
|
|
1135 |
and any method comments - without source; used to generate documentation
|
|
|
1136 |
pages"
|
|
|
1137 |
|
|
|
1138 |
^ self printOutHTMLMethodProtocol:aMethod on:aStream showClassName:false classRef:false
|
|
|
1139 |
|
|
|
1140 |
"Modified: 22.4.1996 / 18:01:56 / cg"
|
|
|
1141 |
"Created: 22.4.1996 / 20:03:30 / cg"
|
|
|
1142 |
!
|
|
|
1143 |
|
|
|
1144 |
printOutHTMLMethodProtocol:aMethod on:aStream showClassName:showClassName classRef:withClassRef
|
|
|
1145 |
"given the source in aString, print the methods message specification
|
|
|
1146 |
and any method comments - without source; used to generate documentation
|
|
|
1147 |
pages"
|
|
|
1148 |
|
|
|
1149 |
|text comment cls sel partStream args argStream who methodSpecLine first
|
|
|
1150 |
firstIndent firstNonEmpty isSubres isObsolete smallOrEmpty
|
|
|
1151 |
ballColor|
|
|
|
1152 |
|
|
|
1153 |
who := aMethod who.
|
|
|
1154 |
cls := who at:1.
|
|
|
1155 |
sel := who at:2.
|
|
|
1156 |
partStream := sel keywords readStream.
|
|
|
1157 |
|
|
|
1158 |
(args := aMethod methodArgNames) notNil ifTrue:[
|
|
|
1159 |
argStream := aMethod methodArgNames readStream.
|
|
|
1160 |
|
|
|
1161 |
methodSpecLine := ''. first := true.
|
|
|
1162 |
1 to:sel numArgs do:[:index |
|
|
|
1163 |
first ifTrue:[
|
|
|
1164 |
first := false.
|
|
|
1165 |
] ifFalse:[
|
|
|
1166 |
methodSpecLine := methodSpecLine , ' '
|
|
|
1167 |
].
|
|
|
1168 |
methodSpecLine := methodSpecLine , '<B>' , partStream next , '</B>'.
|
|
|
1169 |
methodSpecLine := methodSpecLine , ' <I>' , argStream next , '</I>'.
|
|
|
1170 |
].
|
|
|
1171 |
] ifFalse:[
|
|
|
1172 |
methodSpecLine := '<B>' , partStream next , '</B>'
|
|
|
1173 |
].
|
|
|
1174 |
|
|
|
1175 |
isSubres := (aMethod sends:#subclassResponsibility).
|
|
|
1176 |
|
|
|
1177 |
isObsolete := false.
|
|
|
1178 |
((aMethod sends:#obsoleteMethodWarning)
|
|
|
1179 |
or:[(aMethod sends:#obsoleteMethodWarning:)
|
|
|
1180 |
or:[(aMethod sends:#obsoleteMethodWarning:from:)]]) ifTrue:[
|
|
|
1181 |
cls ~~ Object ifTrue:[
|
|
|
1182 |
isObsolete := true
|
|
|
1183 |
]
|
|
|
1184 |
].
|
|
|
1185 |
|
|
|
1186 |
smallOrEmpty := ''.
|
|
|
1187 |
aMethod isPrivate ifTrue:[
|
|
|
1188 |
methodSpecLine := '<i>private</I> ' , methodSpecLine.
|
|
|
1189 |
"/ smallOrEmpty := '-small'.
|
|
|
1190 |
] ifFalse:[
|
|
|
1191 |
aMethod isProtected ifTrue:[
|
|
|
1192 |
methodSpecLine := '<i>protected</I> ' , methodSpecLine.
|
|
|
1193 |
"/ smallOrEmpty := '-small'.
|
|
|
1194 |
] ifFalse:[
|
|
|
1195 |
aMethod isIgnored ifTrue:[
|
|
|
1196 |
methodSpecLine := '[ ' , methodSpecLine , ' ] (<i>invisible</I>)'.
|
|
|
1197 |
"/ smallOrEmpty := '-small'.
|
|
|
1198 |
]
|
|
|
1199 |
]
|
|
|
1200 |
].
|
|
|
1201 |
|
|
|
1202 |
aStream nextPutAll:'<dt>'; cr.
|
|
|
1203 |
|
|
|
1204 |
|
|
|
1205 |
cls isMeta ifTrue:[
|
|
|
1206 |
ballColor := 'yellow'
|
|
|
1207 |
] ifFalse:[
|
|
|
1208 |
ballColor := 'red'
|
|
|
1209 |
].
|
|
|
1210 |
|
|
|
1211 |
aStream nextPutAll:'<img src="pictures/' , ballColor , '-ball' , smallOrEmpty , '.gif" width=6 height=6>'; cr.
|
|
|
1212 |
|
|
|
1213 |
sel := (sel copy
|
|
|
1214 |
replChar:$< withString:'<')
|
|
|
1215 |
replChar:$> withString:'>'.
|
|
|
1216 |
|
|
|
1217 |
withClassRef ifTrue:[
|
|
|
1218 |
aStream nextPutAll:'<a name="' , cls name , '_' , sel ,
|
|
|
1219 |
'" href="../misc/onlyInSTX2.html" action="html:',self name,' htmlDocOf:' , cls name ,
|
|
|
1220 |
'">' , cls name , '</a> ' , methodSpecLine; cr.
|
|
|
1221 |
] ifFalse:[
|
|
|
1222 |
showClassName ifTrue:[
|
|
|
1223 |
methodSpecLine := cls name , ' ' , methodSpecLine
|
|
|
1224 |
].
|
|
|
1225 |
|
|
|
1226 |
aStream nextPutAll:'<a name="' , cls name , '_' , sel ,
|
|
|
1227 |
"/ '" href="' , cls name , '_' , sel , '"' ,
|
|
|
1228 |
'>' , methodSpecLine , '</a>'; cr.
|
|
|
1229 |
].
|
|
|
1230 |
aStream nextPutAll:'<dd>';cr.
|
|
|
1231 |
|
|
|
1232 |
(comment := aMethod comment) notNil ifTrue:[
|
|
|
1233 |
comment := (comment copy
|
|
|
1234 |
replChar:$< withString:'<')
|
|
|
1235 |
replChar:$> withString:'>'.
|
|
|
1236 |
|
|
|
1237 |
comment notEmpty ifTrue:[
|
|
|
1238 |
comment := comment asStringCollection.
|
|
|
1239 |
firstIndent := comment first leftIndent.
|
|
|
1240 |
firstIndent > 0 ifTrue:[
|
|
|
1241 |
comment := comment collect:[:line |
|
|
|
1242 |
line leftIndent >= firstIndent ifTrue:[
|
|
|
1243 |
line copyFrom:firstIndent.
|
|
|
1244 |
] ifFalse:[
|
|
|
1245 |
line
|
|
|
1246 |
]
|
|
|
1247 |
].
|
|
|
1248 |
].
|
|
|
1249 |
firstNonEmpty := comment findFirst:[:line | line notEmpty].
|
|
|
1250 |
firstNonEmpty > 1 ifTrue:[
|
|
|
1251 |
comment := comment copyFrom:firstNonEmpty
|
|
|
1252 |
].
|
|
|
1253 |
comment := comment asString.
|
|
|
1254 |
].
|
|
|
1255 |
|
|
|
1256 |
"/ aStream nextPutAll:'<pre>'; cr.
|
|
|
1257 |
"/ aStream spaces:((text at:2) indexOfNonSeparatorStartingAt:1).
|
|
|
1258 |
comment asStringCollection do:[:line |
|
|
|
1259 |
aStream nextPutAll:line; nextPutAll:'<br>'; cr.
|
|
|
1260 |
].
|
|
|
1261 |
"/ aStream nextPutAll:'</pre>';cr.
|
|
|
1262 |
].
|
|
|
1263 |
|
|
|
1264 |
isSubres ifTrue:[
|
|
|
1265 |
aStream nextPutAll:'<BR>'; cr.
|
|
|
1266 |
aStream nextPutAll:'<I>** This method raises an error - it must be redefined in concrete classes **</I>'; cr.
|
|
|
1267 |
].
|
|
|
1268 |
isObsolete ifTrue:[
|
|
|
1269 |
aStream nextPutAll:'<BR>'; cr.
|
|
|
1270 |
aStream nextPutAll:'<I>** This is an obsolete interface - do not use it (it may vanish in future versions) **</I>'; cr.
|
|
|
1271 |
].
|
|
|
1272 |
|
|
|
1273 |
"Created: 22.4.1996 / 20:03:30 / cg"
|
|
|
1274 |
"Modified: 26.4.1996 / 18:27:13 / cg"
|
|
|
1275 |
!
|
|
|
1276 |
|
|
|
1277 |
printOutHTMLProtocolOf:aClass on:aStream
|
|
|
1278 |
|collectionOfCategories any|
|
|
|
1279 |
|
|
|
1280 |
"/ self printOutDefinitionOn:aPrintStream.
|
|
|
1281 |
|
|
|
1282 |
collectionOfCategories := aClass class categories.
|
|
|
1283 |
any := false.
|
|
|
1284 |
collectionOfCategories notNil ifTrue:[
|
|
|
1285 |
collectionOfCategories := collectionOfCategories asOrderedCollection sort.
|
|
|
1286 |
aStream nextPutAll:'<h2><a name="CLASSPROTOCOL" href="#I_CLASSPROTOCOL">Class protocol:</A></h2>'; cr.
|
|
|
1287 |
collectionOfCategories do:[:aCategory |
|
|
|
1288 |
aCategory ~= 'documentation' ifTrue:[
|
|
|
1289 |
self printOutHTMLCategoryProtocol:aCategory of:aClass class on:aStream.
|
|
|
1290 |
any := true.
|
|
|
1291 |
]
|
|
|
1292 |
].
|
|
|
1293 |
"/ any ifFalse:[
|
|
|
1294 |
"/ aStream nextPutAll:'no new protocol'
|
|
|
1295 |
"/ ].
|
|
|
1296 |
aStream nextPutAll:'<hr>'; cr.
|
|
|
1297 |
].
|
|
|
1298 |
|
|
|
1299 |
|
|
|
1300 |
collectionOfCategories := aClass categories.
|
|
|
1301 |
any := false.
|
|
|
1302 |
collectionOfCategories notNil ifTrue:[
|
|
|
1303 |
collectionOfCategories := collectionOfCategories asOrderedCollection sort.
|
|
|
1304 |
aStream nextPutAll:'<h2><a name="INSTANCEPROTOCOL" href="#I_INSTANCEPROTOCOL">Instance protocol:</A></h2>'; cr.
|
|
|
1305 |
collectionOfCategories do:[:aCategory |
|
|
|
1306 |
self printOutHTMLCategoryProtocol:aCategory of:aClass on:aStream
|
|
|
1307 |
].
|
|
|
1308 |
"/ any ifFalse:[
|
|
|
1309 |
"/ aStream nextPutAll:'no new protocol'
|
|
|
1310 |
"/ ].
|
|
|
1311 |
aStream nextPutAll:'<hr>'; cr.
|
|
|
1312 |
]
|
|
|
1313 |
|
|
|
1314 |
"
|
|
|
1315 |
self printOutHTMLProtocolOf:Float on:Stdout
|
|
|
1316 |
"
|
|
|
1317 |
|
|
|
1318 |
"Created: 22.4.1996 / 20:03:30 / cg"
|
|
|
1319 |
"Modified: 27.4.1996 / 15:05:19 / cg"
|
|
|
1320 |
! !
|
|
|
1321 |
|
|
|
1322 |
!HTMLDocGenerator class methodsFor:'helpers'!
|
|
|
1323 |
|
|
|
1324 |
extractSpecial:pattern from:docu
|
|
|
1325 |
"given a collection of docu lines (from documentation methods comment),
|
|
|
1326 |
extract things like [see also:], [author:] etc.
|
|
|
1327 |
If found, remove the lines from the string collection,
|
|
|
1328 |
and return the extracted ones. Otherwise return nil."
|
|
|
1329 |
|
|
|
1330 |
|srchIdx idx lines l|
|
|
|
1331 |
|
|
|
1332 |
srchIdx := docu findFirst:[:l | l asLowercase withoutSeparators = pattern].
|
|
|
1333 |
srchIdx ~~ 0 ifTrue:[
|
|
|
1334 |
lines := OrderedCollection new.
|
|
|
1335 |
|
|
|
1336 |
idx := srchIdx+1.
|
|
|
1337 |
[idx <= docu size] whileTrue:[
|
|
|
1338 |
l := docu at:idx.
|
|
|
1339 |
(l isNil or:[l withoutSeparators size == 0]) ifTrue:[
|
|
|
1340 |
idx := docu size + 1.
|
|
|
1341 |
] ifFalse:[
|
|
|
1342 |
lines add:l
|
|
|
1343 |
].
|
|
|
1344 |
idx := idx + 1.
|
|
|
1345 |
].
|
|
|
1346 |
|
|
|
1347 |
docu removeFromIndex:srchIdx toIndex:srchIdx+lines size
|
|
|
1348 |
].
|
|
|
1349 |
^ lines
|
|
|
1350 |
|
|
|
1351 |
"Created: 25.4.1996 / 14:16:01 / cg"
|
|
|
1352 |
"Modified: 27.4.1996 / 19:01:07 / cg"
|
|
|
1353 |
! !
|
|
|
1354 |
|
|
|
1355 |
!HTMLDocGenerator class methodsFor:'documentation'!
|
|
|
1356 |
|
|
|
1357 |
version
|
|
|
1358 |
^ '$Header: /cvs/stx/stx/libbasic3/HTMLDocGenerator.st,v 1.1 1996-09-13 09:18:17 cg Exp $'
|
|
|
1359 |
! !
|