author | Jan Vrany <jan.vrany@fit.cvut.cz> |
Sat, 05 Oct 2013 12:51:21 +0100 | |
branch | jv |
changeset 3407 | 989191014bcd |
parent 3405 | cec1fd1367ce |
child 3838 | 474d8ec95b33 |
permissions | -rw-r--r-- |
2797 | 1 |
" |
2 |
COPYRIGHT (c) 2006 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 |
" |
|
2707 | 12 |
"{ Package: 'stx:libbasic3' }" |
13 |
||
14 |
Object subclass:#ProjectChecker |
|
3148 | 15 |
instanceVariableNames:'package packageDef classes methods problems phase |
16 |
checkExtensionsOnly' |
|
2967 | 17 |
classVariableNames:'' |
18 |
poolDictionaries:'' |
|
19 |
category:'System-Support-Projects' |
|
2707 | 20 |
! |
21 |
||
2797 | 22 |
!ProjectChecker class methodsFor:'documentation'! |
23 |
||
24 |
copyright |
|
25 |
" |
|
26 |
COPYRIGHT (c) 2006 by eXept Software AG |
|
27 |
All Rights Reserved |
|
28 |
||
29 |
This software is furnished under a license and may be used |
|
30 |
only in accordance with the terms of that license and with the |
|
31 |
inclusion of the above copyright notice. This software may not |
|
32 |
be provided or otherwise made available to, or used by, any |
|
33 |
other person. No title to or ownership of the software is |
|
34 |
hereby transferred. |
|
35 |
" |
|
2707 | 36 |
! |
37 |
||
38 |
documentation |
|
39 |
" |
|
40 |
A simple project checker that can search whole projects or individual |
|
2853 | 41 |
classes or methods for various problems that may cause build problems such |
42 |
as: |
|
43 |
- inconsistent/messed up project definition class |
|
44 |
- method code problems |
|
2707 | 45 |
|
46 |
NOTE: Not yet finished. This code is meant as a single central entry for all the |
|
47 |
source code management tools like SCM Utilities, NewSystemBrowser ets. That code |
|
2797 | 48 |
will be refactored later once this tool prooves itself useful and mature enough. |
2707 | 49 |
|
50 |
[author:] |
|
51 |
Jan Vrany <jan.vrany@fit.cvut.cz> |
|
52 |
||
53 |
[instance variables:] |
|
54 |
||
55 |
[class variables:] |
|
56 |
||
57 |
[see also:] |
|
2853 | 58 |
Tools::ProjectCheckerBrowser |
2707 | 59 |
|
60 |
" |
|
61 |
! |
|
62 |
||
63 |
examples |
|
64 |
||
65 |
" |
|
66 |
ProjectChecker check: 'stx:libbasic' |
|
2797 | 67 |
ProjectChecker check: 'stx:libtool' |
68 |
ProjectChecker check: 'stx:libbasic3' |
|
2707 | 69 |
" |
70 |
! ! |
|
71 |
||
2853 | 72 |
!ProjectChecker class methodsFor:'instance creation'! |
73 |
||
74 |
forPackage: packageId |
|
75 |
^self new |
|
76 |
package: packageId; |
|
77 |
yourself. |
|
78 |
||
79 |
"Created: / 25-07-2012 / 18:00:06 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
2910 | 80 |
! |
81 |
||
82 |
new |
|
83 |
"return an initialized instance" |
|
84 |
||
85 |
^ self basicNew initialize. |
|
2853 | 86 |
! ! |
87 |
||
2707 | 88 |
!ProjectChecker class methodsFor:'checking'! |
89 |
||
90 |
check: package |
|
91 |
||
92 |
^self new check: package |
|
93 |
||
94 |
"Created: / 11-01-2012 / 16:46:38 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
95 |
! ! |
|
96 |
||
97 |
!ProjectChecker methodsFor:'accessing'! |
|
98 |
||
3148 | 99 |
checkExtensionsOnly:aBoolean |
100 |
checkExtensionsOnly := aBoolean. |
|
101 |
! |
|
102 |
||
2797 | 103 |
classes: aCollection |
104 |
classes := aCollection. |
|
105 |
||
106 |
"Created: / 13-02-2012 / 17:06:31 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
107 |
! |
|
108 |
||
109 |
methods |
|
110 |
^ methods |
|
111 |
! |
|
112 |
||
113 |
methods:something |
|
114 |
methods := something. |
|
115 |
! |
|
116 |
||
2707 | 117 |
package |
118 |
^ package |
|
119 |
! |
|
120 |
||
121 |
package:packageId |
|
2853 | 122 |
package := packageId asSymbol. |
123 |
||
124 |
"Modified: / 11-04-2012 / 16:00:23 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
2797 | 125 |
! |
126 |
||
127 |
problems |
|
2853 | 128 |
^ problems |
2797 | 129 |
|
130 |
"Modified: / 23-02-2012 / 15:14:24 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
2707 | 131 |
! ! |
132 |
||
133 |
!ProjectChecker methodsFor:'checking'! |
|
134 |
||
135 |
check |
|
136 |
||
2910 | 137 |
problems removeAll. |
2797 | 138 |
packageDef := ProjectDefinition definitionClassForPackage: package. |
139 |
packageDef isNil ifTrue:[ |
|
140 |
self addProblem: |
|
141 |
(ProjectProblem newProjectDefinitionDoesNotExist package: package). |
|
142 |
^self |
|
143 |
]. |
|
144 |
||
3148 | 145 |
ActivityNotification raiseRequestWith:self errorString:'Checking package...'. |
146 |
self checkPackage. |
|
147 |
(checkExtensionsOnly ? false) ifFalse:[ |
|
148 |
ActivityNotification raiseRequestWith:self errorString:'Checking classes...'. |
|
149 |
self checkClasses. |
|
150 |
]. |
|
151 |
ActivityNotification raiseRequestWith:self errorString:'Checking methods...'. |
|
152 |
self checkMethods. |
|
2707 | 153 |
|
154 |
"Created: / 11-01-2012 / 16:47:21 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
155 |
! |
|
156 |
||
157 |
check: package |
|
158 |
||
159 |
self package: package. |
|
160 |
self check. |
|
161 |
||
162 |
"Created: / 11-01-2012 / 16:47:21 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
163 |
! ! |
|
164 |
||
165 |
!ProjectChecker methodsFor:'checks-individual'! |
|
166 |
||
167 |
checkClassListConsistency |
|
168 |
"Checks whether all classes listed in #classNamesAndAttributes are present |
|
169 |
and if all present classes are listed" |
|
170 |
||
2910 | 171 |
|classesInImage classesInDescription classesInDescriptionChecked onlyInDescription| |
2707 | 172 |
"WARNING: Copy/paste of ProjectDefinition>>validateDescription" |
173 |
||
174 |
classesInImage := Smalltalk allClasses select:[:cls | (cls package = self package) and:[cls isPrivate not]]. |
|
175 |
"/ classesInDescription := self classes asIdentitySet. |
|
2910 | 176 |
classesInDescription := OrderedCollection new. |
2967 | 177 |
( (packageDef compiled_classNames_common) |
178 |
, (packageDef compiled_classNamesForPlatform:(OperatingSystem platformName)) |
|
2707 | 179 |
, (packageDef autoloaded_classNames)) do:[:nm | |
180 |
|cls| |
|
181 |
||
182 |
cls := Smalltalk at:nm asSymbol. |
|
183 |
cls isNil ifTrue:[ |
|
2797 | 184 |
self addProblem: |
185 |
(ProjectProblem newClassListedButDoesNotExist className: nm) |
|
2707 | 186 |
] ifFalse:[ |
187 |
classesInDescription add:cls. |
|
188 |
]. |
|
189 |
]. |
|
190 |
||
2910 | 191 |
classesInDescriptionChecked := OrderedCollection new. |
2707 | 192 |
classesInDescription do:[:eachClass | |
2910 | 193 |
(classesInDescriptionChecked includes: eachClass) ifTrue:[ |
194 |
self addProblem: |
|
195 |
(ProjectProblem newClassListedMultipleTimes |
|
196 |
className: eachClass name) |
|
197 |
]. |
|
198 |
||
2707 | 199 |
eachClass sharedPoolNames do:[:eachPoolName | |
200 |
|pool| |
|
201 |
||
202 |
pool := eachClass nameSpace classNamed:eachPoolName. |
|
203 |
pool isNil ifTrue:[ |
|
204 |
eachClass nameSpace ~~ Smalltalk ifTrue:[ |
|
205 |
pool := Smalltalk classNamed:eachPoolName. |
|
206 |
] |
|
207 |
]. |
|
208 |
pool isNil ifTrue:[ |
|
2797 | 209 |
self addProblem: |
210 |
(ProjectProblem newClassUsesPoolButItDoesNotExist |
|
211 |
className: eachClass name; |
|
212 |
poolName: eachPoolName). |
|
2707 | 213 |
] ifFalse:[ |
214 |
pool isSharedPool ifFalse:[ |
|
2797 | 215 |
self addProblem: |
216 |
(ProjectProblem newClassUsesPoolButItIsNotASharedPool |
|
217 |
className: eachClass name; |
|
218 |
poolName: eachPoolName). |
|
2707 | 219 |
]. |
220 |
]. |
|
221 |
]. |
|
2910 | 222 |
|
2966
bf5ea36104cd
Fix in #checkClassListConsistency - care about classes with nil superclass (Autoload/Object)
vrany
parents:
2965
diff
changeset
|
223 |
(eachClass superclass notNil "/Care about classes with nil superclass - Object & Autoload |
bf5ea36104cd
Fix in #checkClassListConsistency - care about classes with nil superclass (Autoload/Object)
vrany
parents:
2965
diff
changeset
|
224 |
and:[eachClass superclass package == eachClass package]) ifTrue:[ |
2910 | 225 |
(classesInDescriptionChecked includes: eachClass superclass) ifFalse:[ |
226 |
self addProblem: |
|
227 |
(ProjectProblem newClassListedBeforeItsSuperclass |
|
228 |
className: eachClass name; |
|
229 |
superClassName: eachClass superclass name) |
|
230 |
]. |
|
231 |
]. |
|
232 |
eachClass sharedPools do:[:eachPool| |
|
233 |
eachPool package == eachClass package ifTrue:[ |
|
234 |
(classesInDescriptionChecked includes: eachPool) ifFalse:[ |
|
235 |
self addProblem: |
|
236 |
(ProjectProblem newClassListedBeforeItsPool |
|
237 |
className: eachClass name; |
|
238 |
poolName: eachPool name) |
|
239 |
]. |
|
240 |
]. |
|
241 |
]. |
|
242 |
||
243 |
classesInDescriptionChecked add: eachClass. |
|
2707 | 244 |
]. |
245 |
||
246 |
classesInImage ~= classesInDescription ifTrue:[ |
|
2856
a1cee28488c0
changed: #checkClassListConsistency - do not warn about not-listed classes twice
vrany
parents:
2853
diff
changeset
|
247 |
"This is done later in checkClassesListedInProjectDefinition:" |
a1cee28488c0
changed: #checkClassListConsistency - do not warn about not-listed classes twice
vrany
parents:
2853
diff
changeset
|
248 |
"/ onlyInImage := (classesInImage reject:[:cls | classesInDescription includes:cls]). |
a1cee28488c0
changed: #checkClassListConsistency - do not warn about not-listed classes twice
vrany
parents:
2853
diff
changeset
|
249 |
"/ onlyInImage do:[:cls| |
a1cee28488c0
changed: #checkClassListConsistency - do not warn about not-listed classes twice
vrany
parents:
2853
diff
changeset
|
250 |
"/ self addProblem: |
a1cee28488c0
changed: #checkClassListConsistency - do not warn about not-listed classes twice
vrany
parents:
2853
diff
changeset
|
251 |
"/ (ProjectProblem newClassNotListed className: cls name). |
a1cee28488c0
changed: #checkClassListConsistency - do not warn about not-listed classes twice
vrany
parents:
2853
diff
changeset
|
252 |
"/ ]. |
2707 | 253 |
onlyInDescription := (classesInDescription reject:[:cls | classesInImage includes:cls]). |
254 |
onlyInDescription do:[:cls| |
|
2797 | 255 |
self addProblem: |
256 |
(ProjectProblem newClassListedButDoesNotExist className: cls name) |
|
2707 | 257 |
]. |
258 |
]. |
|
259 |
||
260 |
"Created: / 11-01-2012 / 17:14:33 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
2967 | 261 |
"Modified: / 31-10-2012 / 17:40:56 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
2718 | 262 |
! |
263 |
||
3405
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
264 |
checkClassesAutoloadedSuperclasse: aCollection"of Class" |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
265 |
packageDef classNamesAndAttributesDo:[:clsnm :attributes| |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
266 |
| cls | |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
267 |
|
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
268 |
cls := Smalltalk at: clsnm. |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
269 |
(aCollection includes: cls) ifTrue:[ |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
270 |
(attributes includes: #autoload) ifFalse:[ |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
271 |
"/ Care for Object!! |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
272 |
cls superclass notNil ifTrue:[ |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
273 |
| superDef superNm | |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
274 |
|
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
275 |
superDef := ProjectDefinition definitionClassForPackage: cls superclass package. |
3407
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
276 |
superDef isNil ifTrue:[ |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
277 |
problems add: |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
278 |
(ProjectProblem newClassIsCompiledButSuperclassProjectDefinitionIsMissing |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
279 |
package: package; |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
280 |
className: clsnm; |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
281 |
yourself) |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
282 |
] ifFalse:[ |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
283 |
superNm := cls superclass name. |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
284 |
superDef classNamesAndAttributesDo:[:clsnm2 :attributes2| |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
285 |
clsnm2 == superNm ifTrue:[ |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
286 |
(attributes2 includes: #autoload) ifTrue:[ |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
287 |
problems add: |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
288 |
(ProjectProblem newClassIsCompiledButSuperclassIsAutoloaded |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
289 |
package: package; |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
290 |
className: clsnm; |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
291 |
yourself) |
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
292 |
]. |
3405
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
293 |
]. |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
294 |
]. |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
295 |
] |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
296 |
]. |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
297 |
]. |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
298 |
]. |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
299 |
]. |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
300 |
|
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
301 |
"Created: / 20-09-2013 / 11:08:33 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
3407
989191014bcd
Added new check to ProjectChecker.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3405
diff
changeset
|
302 |
"Modified: / 05-10-2013 / 12:45:44 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
3405
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
303 |
! |
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
304 |
|
2910 | 305 |
checkClassesForMethodsInNoProject:classesToCheck |
306 |
| checker | |
|
307 |
||
308 |
checker := [:cls | |
|
309 |
cls |
|
310 |
selectorsAndMethodsDo:[:sel :mth | |
|
311 |
(mth package isNil or:[ mth package == PackageId noProjectID ]) ifTrue:[ |
|
312 |
"Sigh, special hack for Expecco" |
|
313 |
((cls name = 'Expecco::AbstractApplication class' and:[ sel = 'flags' ]) or:[ |
|
314 |
(cls name = 'Expecco::Browser class' and:[ sel = 'flags' ])]) ifFalse:[ |
|
315 |
self addProblem:(ProjectProblem newMethodInNoPackage className:cls name |
|
316 |
selector:sel). |
|
317 |
] |
|
318 |
] |
|
319 |
] |
|
320 |
]. |
|
321 |
classesToCheck do:[:class | |
|
322 |
checker value:class theMetaclass. |
|
323 |
checker value:class theNonMetaclass. |
|
324 |
] |
|
325 |
||
326 |
"Created: / 13-02-2012 / 18:18:18 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
327 |
! |
|
328 |
||
329 |
checkClassesForNonQualifiedSharedPools: classesToCheck |
|
330 |
||
331 |
classesToCheck do:[:cls| |
|
332 |
cls sharedPoolNames do:[:poolName| |
|
333 |
(Smalltalk at: poolName asSymbol) isNil ifTrue:[ |
|
334 |
| ns | |
|
335 |
||
336 |
ns := cls nameSpace. |
|
337 |
(ns ~~ Smalltalk and:[(ns at: poolName asSymbol) notNil]) ifTrue:[ |
|
338 |
self addProblem: |
|
339 |
(ProjectProblem newClassUsesPoolButItIsNotASharedPool |
|
340 |
className: cls name; |
|
341 |
poolName: poolName) |
|
342 |
] |
|
343 |
] |
|
344 |
] |
|
345 |
]. |
|
346 |
||
347 |
"Created: / 13-09-2012 / 16:34:16 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
348 |
! |
|
349 |
||
2797 | 350 |
checkClassesListedInProjectDefinition: classesToCheck |
351 |
||
352 |
| classNamesListed | |
|
353 |
||
354 |
classNamesListed := packageDef classNames. |
|
355 |
||
356 |
classesToCheck do:[:class| |
|
357 |
(class isPrivate not and:[(classNamesListed includes: class name) not]) ifTrue:[ |
|
358 |
self addProblem: |
|
359 |
(ProjectProblem newClassNotListed className: class name). |
|
360 |
] |
|
361 |
]. |
|
362 |
||
363 |
"Created: / 13-02-2012 / 18:18:17 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
364 |
! |
|
365 |
||
2718 | 366 |
checkExtensionsListConsistency |
367 |
"Checks whether all extensions listed in #extensionMethodNames are present |
|
368 |
and if all extension methods are listed" |
|
369 |
||
370 |
| extensionsListed extensionsPresent | |
|
371 |
||
372 |
extensionsListed := OrderedCollection new. |
|
373 |
packageDef extensionMethodNames pairWiseDo:[:cls :sel| |
|
374 |
extensionsListed add: (Array with: cls with: sel) |
|
375 |
]. |
|
376 |
extensionsPresent := OrderedCollection new. |
|
377 |
packageDef searchForExtensions do:[:each| |
|
2910 | 378 |
"JV@2012-09-07: Do not take Java methods into an account, they |
379 |
should not be listed in extensionMethodNames. |
|
380 |
They are loaded lazily by JavaClassReader and if listed here, |
|
381 |
they would cause an error if the package is loaded from source. |
|
382 |
Sort of a HACK, indeed" |
|
3206
d720d5883a49
Fix in ProjectChecker>>checkExtensionsListConsistency.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3158
diff
changeset
|
383 |
each mclass theNonMetaclass isJavaClass ifFalse:[ |
2910 | 384 |
extensionsPresent add: (Array with: each mclass name with: each selector) |
385 |
]. |
|
2718 | 386 |
]. |
387 |
||
388 |
(extensionsListed \ extensionsPresent) do:[:clsAndSel| |
|
3167 | 389 |
|cls clsName selector| |
390 |
||
391 |
clsName := clsAndSel first. |
|
392 |
selector := clsAndSel second. |
|
393 |
(cls := Smalltalk classNamed: clsName) isNil ifTrue:[ |
|
394 |
self addProblem: |
|
395 |
(ProjectProblem newExtensionMethodsClassDoesNotExist |
|
396 |
className: clsName selector: selector). |
|
397 |
] ifFalse:[ |
|
398 |
(cls compiledMethodAt:selector) isNil ifTrue:[ |
|
399 |
self addProblem: |
|
400 |
(ProjectProblem newExtensionMethodListedButDoesNotExist |
|
401 |
className: clsName selector: selector). |
|
402 |
] ifFalse:[ |
|
403 |
self addProblem: |
|
404 |
(ProjectProblem newExtensionMethodListedButInDifferentPackage |
|
405 |
className: clsName selector: selector). |
|
406 |
] |
|
407 |
] |
|
2718 | 408 |
]. |
409 |
||
410 |
(extensionsPresent \ extensionsListed) do:[:clsAndSel| |
|
2797 | 411 |
self addProblem: |
412 |
(ProjectProblem newExtensionMethodNotListed |
|
413 |
className: clsAndSel first selector: clsAndSel second). |
|
2718 | 414 |
]. |
415 |
||
416 |
"Created: / 12-01-2012 / 12:31:55 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
3206
d720d5883a49
Fix in ProjectChecker>>checkExtensionsListConsistency.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3158
diff
changeset
|
417 |
"Modified: / 29-03-2013 / 19:41:02 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
2718 | 418 |
! |
419 |
||
420 |
checkExtensionsPrerequisites |
|
421 |
"Checks whether packages of all extensions method classes are listed |
|
422 |
in package prerequisites" |
|
423 |
||
3116 | 424 |
|preRequisites| |
425 |
||
426 |
preRequisites := packageDef effectivePreRequisites. |
|
2718 | 427 |
packageDef searchForExtensions do:[:mthd| |
3116 | 428 |
(preRequisites includes: mthd mclass package) ifFalse:[ |
2797 | 429 |
"/ self problem: ('%3 required by extension method but not in prerequisites' bindWith: mthd mclass package) |
430 |
"/ description: ('An extension method %1>>%2 extends class in package %3 but the package is not listed in package''s prerequisited. This leads into missing methods and strange bugs when application is compiled and run!!' bindWith: mthd class with: mthd selector with: mthd class package) |
|
431 |
"/ severity: #error data: mthd |
|
2718 | 432 |
]. |
433 |
] |
|
434 |
||
435 |
"Created: / 12-01-2012 / 12:41:40 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
2797 | 436 |
! |
437 |
||
2853 | 438 |
checkMethodCodingStyle: method |
439 |
"Checks for various coding style violations such as 'self halt' or |
|
440 |
improper indentation :-)" |
|
441 |
||
442 |
"To be implemented" |
|
443 |
||
444 |
"Created: / 11-04-2012 / 12:38:59 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
445 |
! |
|
446 |
||
3161 | 447 |
checkMethodSTCCompilability1: method into: problemIssue |
2853 | 448 |
"Checks is the method can be compiled by STC based on Parser error/warnings" |
449 |
||
3161 | 450 |
| lang compiler | |
451 |
||
2853 | 452 |
lang := method programmingLanguage. |
453 |
lang isSmalltalk ifFalse:[ ^ self ]. |
|
454 |
||
3161 | 455 |
compiler := lang compilerClass new. |
456 |
compiler |
|
2853 | 457 |
compile:method source |
458 |
forClass:method mclass |
|
459 |
inCategory:'others' |
|
3161 | 460 |
notifying:problemIssue |
2853 | 461 |
install:false |
462 |
skipIfSame:false |
|
463 |
silent:false |
|
464 |
foldConstants:true |
|
3161 | 465 |
ifFail:[ ]. |
466 |
||
467 |
compiler usedGlobals do:[:nm | |
|
468 |
(nm startsWith:Smalltalk undeclaredPrefix) ifTrue:[ |
|
469 |
problemIssue |
|
470 |
addWarning:'Contains unresolved reference to: ',(nm copyFrom:(Smalltalk undeclaredPrefix size + 1)) |
|
471 |
from:0 to:0 |
|
472 |
] |
|
473 |
]. |
|
2853 | 474 |
|
475 |
"Created: / 11-04-2012 / 15:31:00 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
476 |
! |
|
477 |
||
3161 | 478 |
checkMethodSTCCompilability2: method into: problemIssue |
2853 | 479 |
"Checks is the method can be compiled by STC based on selected lint rules" |
480 |
||
481 |
"Not yet implemented" |
|
482 |
||
483 |
"Created: / 11-04-2012 / 15:54:06 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
484 |
! |
|
485 |
||
486 |
checkMethodSTCCompilability: method |
|
487 |
"Checks is the method can be compiled by STC (since STC won't compile |
|
488 |
everything bytecode compiler/jit compiler does, sigh" |
|
489 |
||
490 |
| issue | |
|
491 |
||
492 |
"No need to check the method if the class is autoloaded" |
|
493 |
(packageDef autoloaded_classNames includes: method mclass theNonMetaclass name) ifTrue:[ |
|
494 |
^ self |
|
495 |
]. |
|
496 |
||
497 |
issue := ProjectProblem newMethodCompilabilityIssue. |
|
498 |
issue method: method. |
|
499 |
self checkMethodSTCCompilability1: method into: issue. |
|
500 |
self checkMethodSTCCompilability2: method into: issue. |
|
501 |
issue hasIssue ifTrue:[ |
|
502 |
self addProblem: issue |
|
503 |
] |
|
504 |
||
505 |
"Created: / 11-04-2012 / 12:37:17 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
506 |
! |
|
507 |
||
508 |
checkMethodSourceCode: method |
|
509 |
"Checks, whether method's source code is both |
|
510 |
available and parseable. Return true if the code |
|
2966
bf5ea36104cd
Fix in #checkClassListConsistency - care about classes with nil superclass (Autoload/Object)
vrany
parents:
2965
diff
changeset
|
511 |
is syntactically correct, false otherwise" |
2853 | 512 |
|
513 |
| source | |
|
514 |
||
515 |
[ |
|
516 |
source := method source. |
|
517 |
] on: Error do:[ |
|
518 |
self addProblem: |
|
519 |
(ProjectProblem newMethodSourceNotAvailable method: method). |
|
520 |
^false |
|
521 |
]. |
|
2913 | 522 |
method programmingLanguage isSmalltalk ifFalse:[ ^ false ]. |
523 |
||
2853 | 524 |
[ |
525 |
(Parser parseMethod: method source) == #Error ifTrue:[ |
|
526 |
self addProblem: |
|
527 |
(ProjectProblem newMethodSourceCorrupted method: method). |
|
528 |
^false. |
|
529 |
] |
|
530 |
] on: Error do:[ |
|
531 |
self addProblem: |
|
532 |
(ProjectProblem newMethodSourceCorrupted method: method). |
|
533 |
^false. |
|
534 |
]. |
|
535 |
||
536 |
^true |
|
537 |
||
538 |
"Created: / 11-04-2012 / 12:29:06 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
2707 | 539 |
! ! |
540 |
||
541 |
!ProjectChecker methodsFor:'checks-private'! |
|
542 |
||
543 |
checkClasses |
|
2976 | 544 |
|myPackage| |
2797 | 545 |
|
546 |
classes notNil ifTrue:[ |
|
547 |
self checkClasses: classes |
|
548 |
] ifFalse:[ |
|
2976 | 549 |
myPackage := self package. |
550 |
self checkClasses: (Smalltalk allClasses select:[:cls | (cls package = myPackage)]). |
|
2797 | 551 |
]. |
2707 | 552 |
|
553 |
"Created: / 11-01-2012 / 16:55:48 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
554 |
! |
|
555 |
||
2797 | 556 |
checkClasses: classesToCheck |
557 |
||
558 |
self checkClassesListedInProjectDefinition: classesToCheck. |
|
2910 | 559 |
self checkClassesForMethodsInNoProject:classesToCheck. |
560 |
self checkClassesForNonQualifiedSharedPools:classesToCheck. |
|
3405
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
561 |
self checkClassesAutoloadedSuperclasse:classesToCheck. |
2797 | 562 |
|
563 |
"Created: / 13-02-2012 / 18:18:18 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
3405
cec1fd1367ce
New check in `ProjectChecker` for compiled classes with autoloaded superclasses.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3237
diff
changeset
|
564 |
"Modified: / 20-09-2013 / 11:08:33 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
2797 | 565 |
! |
566 |
||
2853 | 567 |
checkMethod: method |
568 |
(self checkMethodSourceCode: method) ifTrue:[ |
|
569 |
"/OK, method's source is OK, perform further checks |
|
3233 | 570 |
"/ ActivityNotification raiseRequestWith:self errorString:'Checking stc compilability...'. |
2853 | 571 |
self checkMethodSTCCompilability: method. |
3233 | 572 |
"/ ActivityNotification raiseRequestWith:self errorString:'Checking coding style...'. |
2853 | 573 |
self checkMethodCodingStyle: method. |
574 |
] |
|
575 |
||
576 |
"Created: / 11-04-2012 / 12:27:33 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
577 |
! |
|
578 |
||
2707 | 579 |
checkMethods |
2853 | 580 |
methods notEmptyOrNil ifTrue:[ |
581 |
self checkMethods: methods. |
|
582 |
^self. |
|
583 |
]. |
|
584 |
||
585 |
self checkMethods: |
|
586 |
(Iterator on:[:whatToDo| |
|
3233 | 587 |
|classesToCheck myPackage| |
588 |
||
589 |
classes notNil ifTrue:[ |
|
590 |
classesToCheck := classes |
|
591 |
] ifFalse:[ |
|
592 |
myPackage := self package. |
|
593 |
classesToCheck := (Smalltalk allClasses select:[:cls | (cls package = myPackage)]). |
|
594 |
]. |
|
595 |
classesToCheck do:[:cls| |
|
596 |
cls theNonMetaclass withAllPrivateClassesDo:[:eachClass | |
|
597 |
ActivityNotification raiseRequestWith:self errorString:('Checking %1...' bindWith:eachClass name). |
|
598 |
eachClass instAndClassSelectorsAndMethodsDo:[:s :m | |
|
3148 | 599 |
m package = package ifTrue:[ |
600 |
((checkExtensionsOnly ? false) not |
|
601 |
or:[ m package ~~ cls package "isExtension" ]) ifTrue:[ |
|
602 |
whatToDo value:m |
|
603 |
] |
|
604 |
] |
|
605 |
] |
|
2853 | 606 |
]. |
607 |
] |
|
608 |
]) |
|
2707 | 609 |
|
610 |
"Created: / 11-01-2012 / 16:55:49 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
611 |
! |
|
612 |
||
2853 | 613 |
checkMethods: methodsToCheck |
614 |
||
615 |
methodsToCheck do:[:m|self checkMethod: m]. |
|
616 |
||
617 |
"Created: / 11-04-2012 / 12:16:58 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
618 |
! |
|
619 |
||
2707 | 620 |
checkPackage |
3148 | 621 |
(checkExtensionsOnly ? false) ifFalse:[ |
622 |
self checkClassListConsistency. |
|
623 |
]. |
|
2718 | 624 |
self checkExtensionsListConsistency. |
625 |
self checkExtensionsPrerequisites. |
|
626 |
||
2716
9a74597bcd4b
Do not use annotations as stc crashes when compiling them
vrany
parents:
2707
diff
changeset
|
627 |
"add more here..." |
2707 | 628 |
|
629 |
"Created: / 11-01-2012 / 16:55:32 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
630 |
! ! |
|
631 |
||
2910 | 632 |
!ProjectChecker methodsFor:'initialization'! |
633 |
||
634 |
initialize |
|
635 |
"Invoked when a new instance is created." |
|
636 |
||
637 |
"/ please change as required (and remove this comment) |
|
638 |
"/ package := nil. |
|
639 |
"/ packageDef := nil. |
|
640 |
"/ classes := nil. |
|
641 |
"/ methods := nil. |
|
642 |
problems := List new. |
|
643 |
"/ phase := nil. |
|
644 |
||
645 |
"/ super initialize. -- commented since inherited method does nothing |
|
646 |
||
647 |
"Modified: / 13-09-2012 / 17:24:41 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
648 |
! ! |
|
649 |
||
2707 | 650 |
!ProjectChecker methodsFor:'reporting'! |
651 |
||
2797 | 652 |
addProblem: aProjectProblem |
653 |
aProjectProblem package: self package. |
|
2707 | 654 |
problems isNil ifTrue:[problems := OrderedCollection new]. |
2797 | 655 |
problems add: aProjectProblem |
2707 | 656 |
|
2797 | 657 |
"Created: / 23-02-2012 / 13:10:46 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
2718 | 658 |
! ! |
659 |
||
2707 | 660 |
!ProjectChecker class methodsFor:'documentation'! |
661 |
||
662 |
version |
|
3233 | 663 |
^ '$Header: /cvs/stx/stx/libbasic3/ProjectChecker.st,v 1.17 2013-04-26 09:46:15 cg Exp $' |
3167 | 664 |
! |
665 |
||
666 |
version_CVS |
|
3233 | 667 |
^ '$Header: /cvs/stx/stx/libbasic3/ProjectChecker.st,v 1.17 2013-04-26 09:46:15 cg Exp $' |
2707 | 668 |
! |
669 |
||
3206
d720d5883a49
Fix in ProjectChecker>>checkExtensionsListConsistency.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3158
diff
changeset
|
670 |
version_HG |
d720d5883a49
Fix in ProjectChecker>>checkExtensionsListConsistency.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3158
diff
changeset
|
671 |
|
d720d5883a49
Fix in ProjectChecker>>checkExtensionsListConsistency.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3158
diff
changeset
|
672 |
^ '$Changeset: <not expanded> $' |
d720d5883a49
Fix in ProjectChecker>>checkExtensionsListConsistency.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3158
diff
changeset
|
673 |
! |
d720d5883a49
Fix in ProjectChecker>>checkExtensionsListConsistency.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
3158
diff
changeset
|
674 |
|
2797 | 675 |
version_SVN |
2966
bf5ea36104cd
Fix in #checkClassListConsistency - care about classes with nil superclass (Autoload/Object)
vrany
parents:
2965
diff
changeset
|
676 |
^ '§Id: ProjectChecker.st 1971 2012-09-27 19:37:25Z vranyj1 §' |
2707 | 677 |
! ! |
3116 | 678 |