|
6179
|
1 |
"
|
|
|
2 |
COPYRIGHT (c) 2004 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 |
|
|
5592
|
13 |
"{ Package: 'stx:libtool' }"
|
|
5591
|
14 |
|
|
|
15 |
"{ NameSpace: Tools }"
|
|
|
16 |
|
|
|
17 |
Object subclass:#ClassChecker
|
|
|
18 |
instanceVariableNames:'checkedClass badClasses badClassInfo badMethods badMethodInfo
|
|
|
19 |
obsoleteWarners allObsoleteMethods checksPerformed'
|
|
|
20 |
classVariableNames:''
|
|
|
21 |
poolDictionaries:''
|
|
|
22 |
category:'Interface-Browsers-New'
|
|
|
23 |
!
|
|
|
24 |
|
|
|
25 |
!ClassChecker class methodsFor:'documentation'!
|
|
|
26 |
|
|
6179
|
27 |
copyright
|
|
|
28 |
"
|
|
|
29 |
COPYRIGHT (c) 2004 by eXept Software AG
|
|
|
30 |
All Rights Reserved
|
|
|
31 |
|
|
|
32 |
This software is furnished under a license and may be used
|
|
|
33 |
only in accordance with the terms of that license and with the
|
|
|
34 |
inclusion of the above copyright notice. This software may not
|
|
|
35 |
be provided or otherwise made available to, or used by, any
|
|
|
36 |
other person. No title to or ownership of the software is
|
|
|
37 |
hereby transferred.
|
|
|
38 |
"
|
|
|
39 |
!
|
|
|
40 |
|
|
5591
|
41 |
documentation
|
|
|
42 |
"
|
|
|
43 |
embeddable application displaying the class-categories.
|
|
|
44 |
Provides an outputGenerator, which enumerates the classes in
|
|
|
45 |
the selected categories.
|
|
|
46 |
|
|
|
47 |
[author:]
|
|
|
48 |
Claus Gittinger (cg@exept.de)
|
|
|
49 |
"
|
|
|
50 |
! !
|
|
|
51 |
|
|
|
52 |
!ClassChecker class methodsFor:'queries'!
|
|
|
53 |
|
|
|
54 |
individualChecks
|
|
|
55 |
"return a list of supported checks"
|
|
|
56 |
|
|
|
57 |
|checks|
|
|
|
58 |
|
|
|
59 |
checks := OrderedCollection new.
|
|
|
60 |
self methodDictionary keysAndValuesDo:[:sel :mthd |
|
|
|
61 |
(mthd category startsWith:'checks') ifTrue:[checks add:sel]
|
|
|
62 |
].
|
|
|
63 |
checks sort.
|
|
|
64 |
^ checks
|
|
|
65 |
|
|
|
66 |
"
|
|
|
67 |
self individualChecks
|
|
|
68 |
"
|
|
|
69 |
|
|
|
70 |
"Created: / 18.8.2000 / 22:30:46 / cg"
|
|
|
71 |
"Modified: / 18.8.2000 / 22:31:02 / cg"
|
|
|
72 |
! !
|
|
|
73 |
|
|
|
74 |
!ClassChecker methodsFor:'accessing'!
|
|
|
75 |
|
|
|
76 |
badClassInfo
|
|
|
77 |
^ badClassInfo
|
|
|
78 |
!
|
|
|
79 |
|
|
|
80 |
badMethodInfo
|
|
|
81 |
^ badMethodInfo
|
|
|
82 |
!
|
|
|
83 |
|
|
|
84 |
checkedClass
|
|
|
85 |
"return the value of the instance variable 'checkedClass' (automatically generated)"
|
|
|
86 |
|
|
|
87 |
^ checkedClass
|
|
|
88 |
!
|
|
|
89 |
|
|
|
90 |
checkedClass:something
|
|
|
91 |
"set the value of the instance variable 'checkedClass' (automatically generated)"
|
|
|
92 |
|
|
|
93 |
checkedClass := something.
|
|
|
94 |
checksPerformed := nil.
|
|
|
95 |
! !
|
|
|
96 |
|
|
|
97 |
!ClassChecker methodsFor:'checking'!
|
|
|
98 |
|
|
|
99 |
allChecks
|
|
|
100 |
self errorChecks.
|
|
|
101 |
self warningChecks.
|
|
|
102 |
self styleChecks.
|
|
|
103 |
!
|
|
|
104 |
|
|
|
105 |
doCheck:whichCheck
|
|
|
106 |
checksPerformed isNil ifTrue:[
|
|
|
107 |
checksPerformed := Set new.
|
|
|
108 |
].
|
|
|
109 |
(checksPerformed includes:whichCheck) ifFalse:[
|
|
|
110 |
checksPerformed add:whichCheck.
|
|
|
111 |
self perform:whichCheck
|
|
|
112 |
]
|
|
|
113 |
!
|
|
|
114 |
|
|
|
115 |
errorChecks
|
|
|
116 |
self doCheck:#subclassResponsibilityNotDefined.
|
|
|
117 |
self doCheck:#sentNotImplemented.
|
|
|
118 |
self doCheck:#definesEqualButNotHash.
|
|
|
119 |
self doCheck:#instanceVariablesNeverWritten.
|
|
|
120 |
!
|
|
|
121 |
|
|
|
122 |
styleChecks
|
|
|
123 |
self doCheck:#checkProtocols.
|
|
6548
|
124 |
"/ self doCheck:#guardingClause.
|
|
5591
|
125 |
!
|
|
|
126 |
|
|
|
127 |
warningChecks
|
|
|
128 |
self doCheck:#messageNeverSentAndNotUsedAsSymbol.
|
|
|
129 |
self doCheck:#sendsObsoleteMessages.
|
|
|
130 |
self doCheck:#instanceVariablesNeverUsed.
|
|
|
131 |
self doCheck:#instanceVariablesNeverWritten.
|
|
|
132 |
self doCheck:#classVariablesNeverUsed.
|
|
|
133 |
self doCheck:#classVariablesNeverWritten.
|
|
|
134 |
self doCheck:#classInstanceVariablesNeverUsed.
|
|
|
135 |
self doCheck:#classInstanceVariablesNeverWritten.
|
|
|
136 |
! !
|
|
|
137 |
|
|
|
138 |
!ClassChecker methodsFor:'checks-individual'!
|
|
|
139 |
|
|
|
140 |
checkProtocols
|
|
|
141 |
checkedClass instAndClassSelectorsAndMethodsDo:[:mSelector :method |
|
|
|
142 |
self checkProtocolOf:method
|
|
|
143 |
]
|
|
|
144 |
!
|
|
|
145 |
|
|
|
146 |
checkVariableNameConventions
|
|
|
147 |
|badInstVars badClassVars|
|
|
|
148 |
|
|
6645
|
149 |
badInstVars := checkedClass instanceVariableNames select:[:varName | varName isUppercaseFirst].
|
|
5591
|
150 |
badClassVars := checkedClass classVarNames select:[:varName | varName first isLowercase].
|
|
|
151 |
|
|
|
152 |
badInstVars notEmpty ifTrue:[
|
|
6645
|
153 |
badInstVars := (badInstVars collect:[:v | '''' , v , '''']) asStringWith:$, .
|
|
|
154 |
self
|
|
|
155 |
rememberBadClass:checkedClass
|
|
|
156 |
info:('instVars ' , badInstVars , ' should be lowercase (#checkNameConventions)').
|
|
5591
|
157 |
].
|
|
|
158 |
badClassVars notEmpty ifTrue:[
|
|
6645
|
159 |
badClassVars := (badClassVars collect:[:v | '''' , v , '''']) asStringWith:$, .
|
|
|
160 |
self
|
|
|
161 |
rememberBadClass:checkedClass
|
|
|
162 |
info:('classVars ' , badClassVars , ' should be uppercase (#checkNameConventions)').
|
|
5591
|
163 |
].
|
|
|
164 |
!
|
|
|
165 |
|
|
|
166 |
classInstanceVariablesNeverUsed
|
|
|
167 |
self instanceVariablesNeverUsedIn:checkedClass theMetaclass.
|
|
|
168 |
!
|
|
|
169 |
|
|
|
170 |
classInstanceVariablesNeverWritten
|
|
|
171 |
self instanceVariablesNeverWrittenIn:checkedClass theMetaclass.
|
|
|
172 |
!
|
|
|
173 |
|
|
|
174 |
classVariablesNeverUsed
|
|
|
175 |
|cls notUsedHere notUsedAnyWhere anySubclass|
|
|
|
176 |
|
|
|
177 |
cls := checkedClass theNonMetaclass.
|
|
|
178 |
notUsedHere := cls classVarNames asSet.
|
|
|
179 |
notUsedHere isEmpty ifTrue:[^ self].
|
|
|
180 |
|
|
|
181 |
self removeUsedClassVariablesIn:cls from:notUsedHere.
|
|
|
182 |
self removeUsedClassVariablesIn:cls class from:notUsedHere.
|
|
|
183 |
|
|
|
184 |
notUsedHere notEmpty ifTrue:[
|
|
|
185 |
notUsedAnyWhere := notUsedHere copy.
|
|
|
186 |
anySubclass := false.
|
|
|
187 |
cls allSubclassesDo:[:eachSubclass |
|
|
|
188 |
anySubclass := true.
|
|
|
189 |
notUsedAnyWhere notEmpty ifTrue:[
|
|
|
190 |
self removeUsedClassVariablesIn:eachSubclass from:notUsedAnyWhere.
|
|
|
191 |
self removeUsedClassVariablesIn:eachSubclass class from:notUsedAnyWhere.
|
|
|
192 |
]
|
|
|
193 |
].
|
|
|
194 |
|
|
|
195 |
notUsedHere do:[:eachVariable |
|
|
|
196 |
|className|
|
|
|
197 |
|
|
|
198 |
className := checkedClass name allBold.
|
|
|
199 |
self
|
|
|
200 |
rememberBadClass:cls
|
|
|
201 |
info:('classVar ' , eachVariable allBold , ' is unused in ' , className , ' (#classVariablesNeverUsed)').
|
|
|
202 |
(notUsedAnyWhere includes:eachVariable) ifTrue:[
|
|
|
203 |
self
|
|
|
204 |
rememberBadClass:cls
|
|
|
205 |
info:('classVar ' , eachVariable allBold , ' is not even used in subclasses of ' , className , ' (#classVariablesNeverUsed)')
|
|
|
206 |
]
|
|
|
207 |
].
|
|
|
208 |
]
|
|
|
209 |
!
|
|
|
210 |
|
|
|
211 |
classVariablesNeverWritten
|
|
|
212 |
|cls notWrittenHere notWrittenAnyWhere anySubclass|
|
|
|
213 |
|
|
|
214 |
cls := checkedClass theNonMetaclass.
|
|
|
215 |
notWrittenHere := cls classVarNames asSet.
|
|
|
216 |
notWrittenHere isEmpty ifTrue:[^ self].
|
|
|
217 |
|
|
|
218 |
self removeWrittenClassVariablesIn:cls from:notWrittenHere.
|
|
|
219 |
self removeWrittenClassVariablesIn:cls class from:notWrittenHere.
|
|
|
220 |
|
|
|
221 |
notWrittenHere notEmpty ifTrue:[
|
|
|
222 |
notWrittenAnyWhere := notWrittenHere copy.
|
|
|
223 |
anySubclass := false.
|
|
|
224 |
cls allSubclassesDo:[:eachSubclass |
|
|
|
225 |
anySubclass := true.
|
|
|
226 |
notWrittenAnyWhere notEmpty ifTrue:[
|
|
|
227 |
self removeWrittenClassVariablesIn:eachSubclass from:notWrittenAnyWhere.
|
|
|
228 |
self removeWrittenClassVariablesIn:eachSubclass class from:notWrittenAnyWhere.
|
|
|
229 |
]
|
|
|
230 |
].
|
|
|
231 |
|
|
|
232 |
notWrittenHere do:[:eachVariable |
|
|
|
233 |
|className|
|
|
|
234 |
|
|
|
235 |
className := cls name allBold.
|
|
|
236 |
self
|
|
|
237 |
rememberBadClass:cls
|
|
|
238 |
info:('classVar ' , eachVariable allBold , ' is not set in ' , className , ' (#classVariablesNeverWritten)').
|
|
|
239 |
(notWrittenAnyWhere includes:eachVariable) ifTrue:[
|
|
|
240 |
self
|
|
|
241 |
rememberBadClass:cls
|
|
|
242 |
info:('classVar ' , eachVariable allBold , ' is not even set in subclasses of ' , className , ' (#classVariablesNeverWritten)')
|
|
|
243 |
]
|
|
|
244 |
].
|
|
|
245 |
]
|
|
|
246 |
!
|
|
|
247 |
|
|
|
248 |
definesEqualButNotHash
|
|
|
249 |
(checkedClass includesSelector:#=) ifTrue:[
|
|
|
250 |
(checkedClass includesSelector:#hash) ifFalse:[
|
|
|
251 |
self
|
|
|
252 |
rememberBadClass:checkedClass
|
|
|
253 |
info:(checkedClass name allBold, ' redefines #=, but not #hash (#definesEqualButNotHash)').
|
|
|
254 |
]
|
|
|
255 |
]
|
|
|
256 |
!
|
|
|
257 |
|
|
6548
|
258 |
guardingClause
|
|
|
259 |
|detector|
|
|
|
260 |
|
|
|
261 |
detector := ParseTreeLintRule guardingClause.
|
|
|
262 |
detector runOnEnvironment: (Array with:checkedClass).
|
|
|
263 |
self halt.
|
|
|
264 |
!
|
|
|
265 |
|
|
5591
|
266 |
instanceVariablesNeverUsed
|
|
|
267 |
self instanceVariablesNeverUsedIn:checkedClass theNonMetaclass.
|
|
|
268 |
!
|
|
|
269 |
|
|
|
270 |
instanceVariablesNeverWritten
|
|
|
271 |
self instanceVariablesNeverWrittenIn:checkedClass theNonMetaclass.
|
|
|
272 |
!
|
|
|
273 |
|
|
|
274 |
messageNeverSent
|
|
|
275 |
"/ old code: (slow)
|
|
|
276 |
"/ checkedClass instAndClassSelectorsAndMethodsDo:[:mSelector :method |
|
|
|
277 |
"/ (self anySendsOf:mSelector) ifFalse:[
|
|
|
278 |
"/ self
|
|
|
279 |
"/ rememberBadMethod:method
|
|
|
280 |
"/ info:('#' , mSelector , ' is nowhere sent (#messageNeverSent)')
|
|
|
281 |
"/ ].
|
|
|
282 |
"/ ].
|
|
|
283 |
|
|
|
284 |
|selectorsOfInterest|
|
|
|
285 |
|
|
|
286 |
selectorsOfInterest := IdentitySet new.
|
|
|
287 |
checkedClass instAndClassSelectorsAndMethodsDo:[:mSelector :method | selectorsOfInterest add:mSelector].
|
|
|
288 |
(self messagesNeverSentIn:selectorsOfInterest) do:[:eachNeverSent |
|
|
|
289 |
self
|
|
|
290 |
rememberBadMethod:(checkedClass compiledMethodAt:eachNeverSent)
|
|
|
291 |
key:#messageNeverSent
|
|
|
292 |
info:('#' , eachNeverSent allBold, ' is nowhere sent (#messageNeverSent)')
|
|
|
293 |
].
|
|
|
294 |
|
|
|
295 |
"Modified: / 18.8.2000 / 22:54:45 / cg"
|
|
|
296 |
!
|
|
|
297 |
|
|
|
298 |
messageNeverSentAndNotUsedAsSymbol
|
|
|
299 |
|selectorsOfInterest|
|
|
|
300 |
|
|
|
301 |
selectorsOfInterest := IdentitySet new.
|
|
|
302 |
checkedClass instAndClassSelectorsAndMethodsDo:[:mSelector :method | selectorsOfInterest add:mSelector].
|
|
|
303 |
(self messagesNeverSentAndNotUsedAsSymbolIn:selectorsOfInterest) do:[:eachNeverSent |
|
|
|
304 |
self
|
|
|
305 |
rememberBadMethod:(checkedClass compiledMethodAt:eachNeverSent)
|
|
|
306 |
key:#messageNeverSentAndNotUsedAsSymbol
|
|
|
307 |
info:('#' , eachNeverSent allBold, ' is nowhere sent and selector-symbol not used in any method (#messageNeverSentAndNotUsedAsSymbol)')
|
|
|
308 |
].
|
|
|
309 |
|
|
|
310 |
"Modified: / 18.8.2000 / 23:10:56 / cg"
|
|
|
311 |
!
|
|
|
312 |
|
|
|
313 |
sendsObsoleteMessages
|
|
|
314 |
obsoleteWarners isNil ifTrue:[
|
|
6513
|
315 |
obsoleteWarners := Object selectors select:[:each | each startsWith:'obsoleteMethodWarning'].
|
|
5591
|
316 |
].
|
|
|
317 |
allObsoleteMethods isNil ifTrue:[
|
|
6513
|
318 |
allObsoleteMethods := IdentitySet new.
|
|
|
319 |
Method allSubInstancesDo:[:eachMethod | |lits selector|
|
|
|
320 |
((lits := eachMethod literals) notNil
|
|
|
321 |
and:[lits includesAny:obsoleteWarners]) ifTrue:[
|
|
|
322 |
(eachMethod messagesSent includesAny:obsoleteWarners) ifTrue:[
|
|
|
323 |
selector := eachMethod selector.
|
|
|
324 |
selector notNil ifTrue:[
|
|
|
325 |
allObsoleteMethods add:selector.
|
|
|
326 |
]
|
|
|
327 |
].
|
|
|
328 |
].
|
|
|
329 |
].
|
|
5591
|
330 |
|
|
6513
|
331 |
"/ manually patchup; there are some which should not be considered as bad ...
|
|
|
332 |
allObsoleteMethods removeAllFoundIn:#( #',' #'at:' #'at:put:' #'raise').
|
|
|
333 |
allObsoleteMethods removeAllFoundIn:#( #'asText').
|
|
|
334 |
allObsoleteMethods removeAllFoundIn:obsoleteWarners.
|
|
5591
|
335 |
].
|
|
|
336 |
|
|
|
337 |
checkedClass instAndClassSelectorsAndMethodsDo:[:sel :mthd |
|
|
6513
|
338 |
|lits sentMessages whichOnes pT searcher nodes|
|
|
5591
|
339 |
|
|
6513
|
340 |
((lits := mthd literals) notNil
|
|
|
341 |
and:[lits includesAny:allObsoleteMethods]) ifTrue:[
|
|
|
342 |
sentMessages := mthd messagesSent.
|
|
|
343 |
(sentMessages includesAny:allObsoleteMethods) ifTrue:[
|
|
|
344 |
whichOnes := sentMessages select:[:each | allObsoleteMethods includes:each].
|
|
5591
|
345 |
|
|
6513
|
346 |
(RBParser notNil
|
|
|
347 |
and:[RBParser isLoaded]) ifTrue:[
|
|
|
348 |
"/ lets look at this a bit more detailed;
|
|
|
349 |
"/ parse it and see if we can filter out any messages
|
|
|
350 |
"/ (i.e. look if we can figure out the receiver type)
|
|
5591
|
351 |
|
|
|
352 |
"/ pT := RBParser
|
|
|
353 |
"/ parseMethod: (mthd source)
|
|
|
354 |
"/ onError: [:aString :pos | nil].
|
|
|
355 |
"/ pT notNil ifTrue:[
|
|
|
356 |
"/ searcher := ParseTreeSearcher
|
|
|
357 |
"/ allMessageSendsMatchingAny:whichOnes ignoreCase:false.
|
|
|
358 |
"/ nodes := searcher executeTree:pT initialAnswer:(OrderedCollection new).
|
|
|
359 |
"/ nodes := nodes
|
|
|
360 |
"/ select:
|
|
|
361 |
"/ [:aSendNode |
|
|
|
362 |
"/ self halt.
|
|
|
363 |
"/ ].
|
|
|
364 |
"/ whichOnes := nodes collect:[:aSendNode | aSendNode selector].
|
|
|
365 |
"/ ].
|
|
6513
|
366 |
].
|
|
5591
|
367 |
|
|
6513
|
368 |
whichOnes asOrderedCollection sort do:[:eachObsoleteMessage |
|
|
|
369 |
self
|
|
|
370 |
rememberBadMethod:mthd
|
|
|
371 |
key:#sendsObsoleteMessages
|
|
|
372 |
info:('possibly sends an obsolete message: ' , eachObsoleteMessage , ' (#sendsObsoleteMessages)')
|
|
|
373 |
].
|
|
|
374 |
].
|
|
|
375 |
]
|
|
5591
|
376 |
]
|
|
|
377 |
!
|
|
|
378 |
|
|
|
379 |
sentNotImplemented
|
|
|
380 |
|alreadyChecked alreadyCheckedSelf alreadyCheckedSuper|
|
|
|
381 |
|
|
|
382 |
alreadyChecked := IdentitySet new.
|
|
|
383 |
alreadyCheckedSelf := IdentitySet new.
|
|
|
384 |
alreadyCheckedSuper := IdentitySet new.
|
|
|
385 |
|
|
|
386 |
checkedClass methodDictionary keysAndValuesDo:[:mSelector :method |
|
|
|
387 |
|sentSelectors selfSelectors superSelectors selectorsNoWhereImplemented|
|
|
|
388 |
|
|
|
389 |
selectorsNoWhereImplemented := IdentitySet new.
|
|
|
390 |
sentSelectors := method messagesSent.
|
|
|
391 |
sentSelectors do:[:eachSelector |
|
|
|
392 |
(alreadyChecked includes:eachSelector) ifFalse:[
|
|
|
393 |
(self anyImplementationOf:eachSelector) ifTrue:[
|
|
|
394 |
alreadyChecked add:eachSelector
|
|
|
395 |
] ifFalse:[
|
|
|
396 |
selectorsNoWhereImplemented add:eachSelector.
|
|
|
397 |
self
|
|
|
398 |
rememberBadMethod:method
|
|
|
399 |
key:#sentNotImplemented
|
|
|
400 |
info:('#' , eachSelector allBold, ' is nowhere implemented (#sentNotImplemented)')
|
|
|
401 |
]
|
|
|
402 |
]
|
|
|
403 |
].
|
|
|
404 |
|
|
|
405 |
selfSelectors := method messagesSentToSelf.
|
|
|
406 |
selfSelectors do:[:eachSelector |
|
|
|
407 |
(selectorsNoWhereImplemented includes:eachSelector) ifFalse:[
|
|
|
408 |
(alreadyCheckedSelf includes:eachSelector) ifFalse:[
|
|
|
409 |
(self anyImplementationOf:eachSelector inOrAbove:checkedClass) ifTrue:[
|
|
|
410 |
alreadyCheckedSelf add:eachSelector
|
|
|
411 |
] ifFalse:[
|
|
|
412 |
self
|
|
|
413 |
rememberBadMethod:method
|
|
|
414 |
key:#sentNotImplemented
|
|
|
415 |
info:('#' , eachSelector allBold, ' is not implemented in the class (#sentNotImplemented)')
|
|
|
416 |
]
|
|
|
417 |
]
|
|
|
418 |
]
|
|
|
419 |
].
|
|
|
420 |
|
|
|
421 |
superSelectors := method messagesSentToSuper.
|
|
|
422 |
superSelectors do:[:eachSelector |
|
|
|
423 |
(selectorsNoWhereImplemented includes:eachSelector) ifFalse:[
|
|
|
424 |
(alreadyCheckedSuper includes:eachSelector) ifFalse:[
|
|
|
425 |
(self anyImplementationOf:eachSelector inOrAbove:(checkedClass superclass)) ifTrue:[
|
|
|
426 |
alreadyCheckedSuper add:eachSelector
|
|
|
427 |
] ifFalse:[
|
|
|
428 |
self
|
|
|
429 |
rememberBadMethod:method
|
|
|
430 |
key:#sentNotImplemented
|
|
|
431 |
info:('#' , eachSelector allBold, ' is not implemented in any superclass (#sentNotImplemented)')
|
|
|
432 |
]
|
|
|
433 |
]
|
|
|
434 |
]
|
|
|
435 |
].
|
|
|
436 |
].
|
|
|
437 |
!
|
|
|
438 |
|
|
|
439 |
subclassResponsibilityNotDefined
|
|
|
440 |
|classesInBetween|
|
|
|
441 |
|
|
|
442 |
checkedClass allSuperclasses do:[:eachSuperClass |
|
|
|
443 |
eachSuperClass methodDictionary keysAndValuesDo:[:mSelector :method |
|
|
|
444 |
(method referencesLiteral:#subclassResponsibility) ifTrue:[
|
|
|
445 |
"/ parse it to see if it really does ...
|
|
|
446 |
(method sends:#subclassResponsibility) ifTrue:[
|
|
|
447 |
"/ ok, got one;
|
|
|
448 |
"/ now, see if it is defined below this superClass
|
|
|
449 |
classesInBetween := checkedClass withAllSuperclasses copy.
|
|
|
450 |
classesInBetween removeAll:(eachSuperClass withAllSuperclasses).
|
|
|
451 |
(self anyImplementationOf:mSelector in:classesInBetween) ifFalse:[
|
|
|
452 |
(self methodShouldBeIgnoredInSubclassResponsibilityNotDefined:method)
|
|
|
453 |
ifFalse:[
|
|
|
454 |
self
|
|
|
455 |
rememberBadMethod:method
|
|
|
456 |
key:#subclassResponsibilityNotDefined
|
|
|
457 |
info:(checkedClass name allBold , ' should redefine the #' , mSelector allBold , ' method (#subclassResponsibilityNotDefined)').
|
|
|
458 |
].
|
|
|
459 |
].
|
|
|
460 |
]
|
|
|
461 |
]
|
|
|
462 |
]
|
|
|
463 |
].
|
|
|
464 |
! !
|
|
|
465 |
|
|
|
466 |
!ClassChecker methodsFor:'helpers'!
|
|
|
467 |
|
|
|
468 |
anyImplementationOf:aSelector
|
|
|
469 |
Smalltalk allClassesDo:[:eachClass |
|
|
|
470 |
(eachClass theNonMetaclass includesSelector:aSelector) ifTrue:[^ true].
|
|
|
471 |
(eachClass theMetaclass includesSelector:aSelector) ifTrue:[^ true].
|
|
|
472 |
].
|
|
|
473 |
^ false
|
|
|
474 |
!
|
|
|
475 |
|
|
|
476 |
anyImplementationOf:aSelector in:aCollectionOfClasses
|
|
6645
|
477 |
^ aCollectionOfClasses
|
|
|
478 |
contains:[:aClass | (aClass includesSelector:aSelector) ].
|
|
5591
|
479 |
!
|
|
|
480 |
|
|
|
481 |
anyImplementationOf:aSelector inOrAbove:aClass
|
|
|
482 |
aClass withAllSuperclassesDo:[:eachClass |
|
|
|
483 |
(eachClass includesSelector:aSelector) ifTrue:[^ true].
|
|
|
484 |
].
|
|
|
485 |
^ false
|
|
|
486 |
!
|
|
|
487 |
|
|
|
488 |
anySendsOf:aSelector
|
|
|
489 |
Smalltalk allClassesDo:[:eachClass |
|
|
|
490 |
eachClass instAndClassSelectorsAndMethodsDo:[:mSelector :mthd |
|
|
|
491 |
(mthd sends:aSelector) ifTrue:[^ true].
|
|
|
492 |
].
|
|
|
493 |
].
|
|
|
494 |
^ false
|
|
|
495 |
!
|
|
|
496 |
|
|
|
497 |
checkProtocolOf:aMethod
|
|
|
498 |
|mClass mSelector protocol superClass implClass superProtocol|
|
|
|
499 |
|
|
|
500 |
mClass := aMethod mclass.
|
|
|
501 |
mSelector := aMethod selector.
|
|
|
502 |
|
|
|
503 |
protocol := aMethod category.
|
|
|
504 |
protocol isNil ifTrue: [^true].
|
|
|
505 |
|
|
|
506 |
superClass := mClass superclass.
|
|
|
507 |
superClass isNil ifTrue: [^true].
|
|
|
508 |
|
|
|
509 |
implClass := superClass whichClassIncludesSelector:mSelector.
|
|
|
510 |
implClass isNil ifTrue: [^true].
|
|
|
511 |
|
|
|
512 |
superProtocol := (implClass compiledMethodAt:mSelector) category.
|
|
|
513 |
superProtocol = protocol ifTrue: [^true].
|
|
|
514 |
superProtocol isNil ifTrue: [^true].
|
|
|
515 |
|
|
|
516 |
self
|
|
|
517 |
rememberBadMethod:aMethod
|
|
|
518 |
key:#checkProtocols
|
|
|
519 |
info:('#' , mSelector allBold , ' is classified under "' , protocol allBold , '" in '
|
|
|
520 |
, mClass name , ' and under "' , superProtocol allBold , '" in ' , implClass name
|
|
|
521 |
, ' (#checkProtocols)')
|
|
|
522 |
|
|
|
523 |
"Modified: / 18.8.2000 / 23:13:53 / cg"
|
|
|
524 |
!
|
|
|
525 |
|
|
|
526 |
checkUnusedVariables:aMethod rememberReadInstVarsIn:readInstVars writtenInstVarsIn:writtenInstVars readClassVarsIn:readClassVars writtenClassVarsIn:writtenClassVars
|
|
|
527 |
|p mClass sourceString|
|
|
|
528 |
|
|
|
529 |
sourceString := aMethod source.
|
|
|
530 |
|
|
|
531 |
mClass := aMethod mclass.
|
|
|
532 |
|
|
|
533 |
p := Parser parseMethodSilent:sourceString in:mClass.
|
|
|
534 |
readInstVars addAll:(p readInstVars).
|
|
|
535 |
writtenInstVars addAll:(p modifiedInstVars).
|
|
|
536 |
readClassVars addAll:(p readClassVars).
|
|
|
537 |
writtenClassVars addAll:(p modifiedClassVars).
|
|
|
538 |
!
|
|
|
539 |
|
|
|
540 |
instanceVariablesNeverUsedIn:aClass
|
|
|
541 |
|notUsedHere notUsedAnyWhere anySubclass|
|
|
|
542 |
|
|
|
543 |
notUsedHere := aClass instVarNames asSet.
|
|
|
544 |
notUsedHere isEmpty ifTrue:[^ self].
|
|
|
545 |
|
|
|
546 |
self removeUsedInstanceVariablesIn:aClass from:notUsedHere.
|
|
|
547 |
|
|
|
548 |
notUsedHere notEmpty ifTrue:[
|
|
|
549 |
notUsedAnyWhere := notUsedHere copy.
|
|
|
550 |
anySubclass := false.
|
|
|
551 |
aClass allSubclassesDo:[:eachSubclass |
|
|
|
552 |
anySubclass := true.
|
|
|
553 |
notUsedAnyWhere notEmpty ifTrue:[
|
|
|
554 |
self removeUsedInstanceVariablesIn:eachSubclass from:notUsedAnyWhere.
|
|
|
555 |
]
|
|
|
556 |
].
|
|
|
557 |
|
|
|
558 |
notUsedHere do:[:eachVariable |
|
|
|
559 |
|className|
|
|
|
560 |
|
|
|
561 |
className := aClass name allBold.
|
|
|
562 |
self
|
|
|
563 |
rememberBadClass:aClass
|
|
|
564 |
info:('instVar ' , eachVariable allBold , ' is unused in ' , className , ' (#instanceVariablesNeverUsed)').
|
|
|
565 |
|
|
|
566 |
anySubclass ifTrue:[
|
|
|
567 |
(notUsedAnyWhere includes:eachVariable) ifTrue:[
|
|
|
568 |
self
|
|
|
569 |
rememberBadClass:aClass
|
|
|
570 |
info:('instVar ' , eachVariable allBold , ' is not even used in subclasses of ' , className , ' (#instanceVariablesNeverUsed)')
|
|
|
571 |
]
|
|
|
572 |
]
|
|
|
573 |
].
|
|
|
574 |
]
|
|
|
575 |
!
|
|
|
576 |
|
|
|
577 |
instanceVariablesNeverWrittenIn:aClass
|
|
|
578 |
|notWrittenHere notWrittenAnyWhere anySubclass|
|
|
|
579 |
|
|
|
580 |
notWrittenHere := aClass instVarNames asSet.
|
|
|
581 |
notWrittenHere isEmpty ifTrue:[^ self].
|
|
|
582 |
|
|
|
583 |
self removeWrittenInstanceVariablesIn:aClass from:notWrittenHere.
|
|
|
584 |
|
|
|
585 |
notWrittenHere notEmpty ifTrue:[
|
|
|
586 |
notWrittenAnyWhere := notWrittenHere copy.
|
|
|
587 |
anySubclass := false.
|
|
|
588 |
aClass allSubclassesDo:[:eachSubclass |
|
|
|
589 |
anySubclass := true.
|
|
|
590 |
notWrittenAnyWhere notEmpty ifTrue:[
|
|
|
591 |
self removeWrittenInstanceVariablesIn:eachSubclass from:notWrittenAnyWhere.
|
|
|
592 |
]
|
|
|
593 |
].
|
|
|
594 |
|
|
|
595 |
notWrittenHere do:[:eachVariable |
|
|
|
596 |
|className|
|
|
|
597 |
|
|
|
598 |
className := aClass name allBold.
|
|
|
599 |
self
|
|
|
600 |
rememberBadClass:aClass
|
|
|
601 |
info:('instVar ' , eachVariable allBold , ' is nowhere set in ' , className , ' (#instanceVariablesNeverWritten)').
|
|
|
602 |
anySubclass ifTrue:[
|
|
|
603 |
(notWrittenAnyWhere includes:eachVariable) ifTrue:[
|
|
|
604 |
self
|
|
|
605 |
rememberBadClass:aClass
|
|
|
606 |
info:('instVar ' , eachVariable allBold , ' is not even set in subclasses of ' , className , ' (#instanceVariablesNeverWritten)')
|
|
|
607 |
]
|
|
|
608 |
]
|
|
|
609 |
].
|
|
|
610 |
]
|
|
|
611 |
!
|
|
|
612 |
|
|
|
613 |
messagesNeverSentAndNotUsedAsSymbolIn:selectorsOfInterest
|
|
|
614 |
|remaining toRemove checkBlock|
|
|
|
615 |
|
|
|
616 |
remaining := selectorsOfInterest copy asIdentitySet.
|
|
|
617 |
toRemove := IdentitySet new.
|
|
|
618 |
|
|
|
619 |
checkBlock := [:eachClass |
|
|
|
620 |
eachClass instAndClassSelectorsAndMethodsDo:[:mSel :mthd | |lits|
|
|
|
621 |
lits := mthd literals.
|
|
|
622 |
lits notNil ifTrue:[
|
|
|
623 |
lits traverse:[:eachLiteral |
|
|
|
624 |
eachLiteral isSymbol ifTrue:[
|
|
|
625 |
remaining remove:eachLiteral ifAbsent:nil.
|
|
|
626 |
]
|
|
|
627 |
].
|
|
|
628 |
remaining isEmpty ifTrue:[^ remaining].
|
|
|
629 |
]
|
|
|
630 |
].
|
|
|
631 |
].
|
|
|
632 |
|
|
|
633 |
"/ start searching in the checkedClass - chances are high, we find some here
|
|
|
634 |
checkBlock value:checkedClass.
|
|
|
635 |
checkedClass superclass notNil ifTrue:[checkBlock value:checkedClass superclass].
|
|
|
636 |
Smalltalk allClassesDo:checkBlock.
|
|
|
637 |
|
|
|
638 |
^ remaining
|
|
|
639 |
|
|
|
640 |
"Modified: / 18.8.2000 / 23:05:53 / cg"
|
|
|
641 |
"Created: / 18.8.2000 / 23:06:55 / cg"
|
|
|
642 |
!
|
|
|
643 |
|
|
|
644 |
messagesNeverSentIn:selectorsOfInterest
|
|
|
645 |
|remaining|
|
|
|
646 |
|
|
|
647 |
remaining := selectorsOfInterest copy.
|
|
|
648 |
Smalltalk allClassesDo:[:eachClass |
|
|
|
649 |
eachClass instAndClassSelectorsAndMethodsDo:[:mSelector :mthd | |lits|
|
|
|
650 |
lits := mthd literals.
|
|
|
651 |
lits notNil ifTrue:[
|
|
|
652 |
(lits includesAny:remaining) ifTrue:[
|
|
|
653 |
remaining removeAllFoundIn:(mthd messagesSent).
|
|
|
654 |
remaining isEmpty ifTrue:[^ remaining].
|
|
|
655 |
]
|
|
|
656 |
]
|
|
|
657 |
].
|
|
|
658 |
].
|
|
|
659 |
^ remaining
|
|
|
660 |
|
|
|
661 |
"Created: / 18.8.2000 / 22:53:38 / cg"
|
|
|
662 |
"Modified: / 18.8.2000 / 22:56:59 / cg"
|
|
|
663 |
!
|
|
|
664 |
|
|
|
665 |
methodShouldBeIgnoredInSubclassResponsibilityNotDefined:aMethod
|
|
|
666 |
"a kludge for now - would like to have a pragma, resource or other
|
|
|
667 |
way to mark such a method"
|
|
|
668 |
|
|
|
669 |
aMethod == (Object compiledMethodAt:#implementedBySubclass) ifTrue:[^ true].
|
|
|
670 |
aMethod == (Object compiledMethodAt:#readBinaryContentsFromData:manager:) ifTrue:[^ true].
|
|
6511
|
671 |
aMethod == (Object compiledMethodAt:#finalize) ifTrue:[^ true].
|
|
5591
|
672 |
^ false.
|
|
|
673 |
!
|
|
|
674 |
|
|
|
675 |
rememberBadClass:class info:whatIsWrong
|
|
|
676 |
|entry|
|
|
|
677 |
|
|
|
678 |
badClasses isNil ifTrue:[
|
|
|
679 |
badClasses := IdentitySet new.
|
|
|
680 |
].
|
|
|
681 |
badClasses add:class.
|
|
|
682 |
|
|
|
683 |
badClassInfo isNil ifTrue:[
|
|
|
684 |
badClassInfo := IdentityDictionary new.
|
|
|
685 |
].
|
|
|
686 |
entry := badClassInfo at:class ifAbsentPut:[ OrderedCollection new ].
|
|
|
687 |
entry add:whatIsWrong.
|
|
|
688 |
!
|
|
|
689 |
|
|
|
690 |
rememberBadMethod:method key:key info:whatIsWrong
|
|
|
691 |
|entry|
|
|
|
692 |
|
|
|
693 |
badMethods isNil ifTrue:[
|
|
|
694 |
badMethods := Set new.
|
|
|
695 |
].
|
|
|
696 |
(badMethods includes:(method -> key)) ifTrue:[^ self].
|
|
|
697 |
|
|
|
698 |
badMethods add:(method -> key).
|
|
|
699 |
|
|
|
700 |
badMethodInfo isNil ifTrue:[
|
|
|
701 |
badMethodInfo := IdentityDictionary new.
|
|
|
702 |
].
|
|
|
703 |
entry := badMethodInfo at:method ifAbsentPut:[ OrderedCollection new ].
|
|
|
704 |
entry add:whatIsWrong.
|
|
|
705 |
!
|
|
|
706 |
|
|
|
707 |
rememberBadMethods:methods key:key info:whatIsWrong
|
|
|
708 |
methods do:[:eachMethod |
|
|
|
709 |
self rememberBadMethod:eachMethod key:key info:whatIsWrong
|
|
|
710 |
].
|
|
|
711 |
!
|
|
|
712 |
|
|
|
713 |
removeUsedClassVariablesIn:aClass from:aCollectionOfVariablenames
|
|
|
714 |
aClass selectorsAndMethodsDo:[:mSelector :method |
|
|
|
715 |
|src usedVars parser|
|
|
|
716 |
|
|
|
717 |
src := method source.
|
|
|
718 |
src notNil ifTrue:[
|
|
|
719 |
parser := Parser
|
|
|
720 |
parseMethod:src
|
|
|
721 |
in:aClass
|
|
|
722 |
ignoreErrors:true
|
|
|
723 |
ignoreWarnings:true.
|
|
|
724 |
|
|
|
725 |
(parser notNil and:[parser ~~ #Error]) ifTrue:[
|
|
|
726 |
aCollectionOfVariablenames removeAllFoundIn:(parser usedClassVars).
|
|
|
727 |
aCollectionOfVariablenames isEmpty ifTrue:[^ self].
|
|
|
728 |
]
|
|
|
729 |
].
|
|
|
730 |
].
|
|
|
731 |
!
|
|
|
732 |
|
|
|
733 |
removeUsedInstanceVariablesIn:aClass from:aCollectionOfVariablenames
|
|
|
734 |
aClass selectorsAndMethodsDo:[:mSelector :method |
|
|
|
735 |
|src usedVars parser|
|
|
|
736 |
|
|
|
737 |
src := method source.
|
|
|
738 |
src notNil ifTrue:[
|
|
|
739 |
parser := Parser
|
|
|
740 |
parseMethod:src
|
|
|
741 |
in:aClass
|
|
|
742 |
ignoreErrors:true
|
|
|
743 |
ignoreWarnings:true.
|
|
|
744 |
|
|
|
745 |
(parser notNil and:[parser ~~ #Error]) ifTrue:[
|
|
|
746 |
aCollectionOfVariablenames removeAllFoundIn:(parser usedInstVars).
|
|
|
747 |
aCollectionOfVariablenames isEmpty ifTrue:[^ self].
|
|
|
748 |
]
|
|
|
749 |
].
|
|
|
750 |
].
|
|
|
751 |
!
|
|
|
752 |
|
|
|
753 |
removeWrittenClassVariablesIn:aClass from:aCollectionOfVariablenames
|
|
|
754 |
aClass selectorsAndMethodsDo:[:mSelector :method |
|
|
|
755 |
|src usedVars parser|
|
|
|
756 |
|
|
|
757 |
src := method source.
|
|
|
758 |
src notNil ifTrue:[
|
|
|
759 |
parser := Parser
|
|
|
760 |
parseMethod:src
|
|
|
761 |
in:aClass
|
|
|
762 |
ignoreErrors:true
|
|
|
763 |
ignoreWarnings:true.
|
|
|
764 |
|
|
|
765 |
(parser notNil and:[parser ~~ #Error]) ifTrue:[
|
|
|
766 |
aCollectionOfVariablenames removeAllFoundIn:(parser modifiedClassVars).
|
|
|
767 |
aCollectionOfVariablenames isEmpty ifTrue:[^ self].
|
|
|
768 |
]
|
|
|
769 |
].
|
|
|
770 |
].
|
|
|
771 |
!
|
|
|
772 |
|
|
|
773 |
removeWrittenInstanceVariablesIn:aClass from:aCollectionOfVariablenames
|
|
|
774 |
aClass selectorsAndMethodsDo:[:mSelector :method |
|
|
|
775 |
|src usedVars parser|
|
|
|
776 |
|
|
|
777 |
src := method source.
|
|
|
778 |
src notNil ifTrue:[
|
|
|
779 |
parser := Parser
|
|
|
780 |
parseMethod:src
|
|
|
781 |
in:aClass
|
|
|
782 |
ignoreErrors:true
|
|
|
783 |
ignoreWarnings:true.
|
|
|
784 |
|
|
|
785 |
(parser notNil and:[parser ~~ #Error]) ifTrue:[
|
|
|
786 |
aCollectionOfVariablenames removeAllFoundIn:(parser modifiedInstVars).
|
|
|
787 |
aCollectionOfVariablenames isEmpty ifTrue:[^ self].
|
|
|
788 |
]
|
|
|
789 |
].
|
|
|
790 |
].
|
|
|
791 |
! !
|
|
|
792 |
|
|
|
793 |
!ClassChecker class methodsFor:'documentation'!
|
|
|
794 |
|
|
|
795 |
version
|
|
6645
|
796 |
^ '$Header: /cvs/stx/stx/libtool/Tools_ClassChecker.st,v 1.7 2006-03-06 08:53:33 cg Exp $'
|
|
5591
|
797 |
! !
|