author | Claus Gittinger <cg@exept.de> |
Thu, 17 Jul 2014 19:26:06 +0200 | |
changeset 245 | da6af4889b3a |
parent 200 | e35a3f4b586b |
child 252 | 0543437ef38a |
permissions | -rw-r--r-- |
168 | 1 |
"{ Package: 'stx:goodies/builder/reports' }" |
2 |
||
3 |
"{ NameSpace: Builder }" |
|
4 |
||
5 |
Object subclass:#ReportSourceInfo |
|
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
6 |
instanceVariableNames:'offsets lineEnds package' |
168 | 7 |
classVariableNames:'' |
8 |
poolDictionaries:'' |
|
9 |
category:'Builder-Reports-Utils' |
|
10 |
! |
|
11 |
||
12 |
Stream subclass:#LineCountingStream |
|
13 |
instanceVariableNames:'position lineEnds' |
|
14 |
classVariableNames:'' |
|
15 |
poolDictionaries:'' |
|
16 |
privateIn:ReportSourceInfo |
|
17 |
! |
|
18 |
||
19 |
!ReportSourceInfo class methodsFor:'documentation'! |
|
20 |
||
21 |
documentation |
|
22 |
" |
|
23 |
Utility class to map line numbers in methods to global |
|
24 |
line number in source file (in chunk-formatted .st file) |
|
25 |
||
26 |
[author:] |
|
27 |
Jan Vrany <jan.vrany@fit.cvut.cz> |
|
28 |
||
29 |
[instance variables:] |
|
30 |
||
31 |
[class variables:] |
|
32 |
||
33 |
[see also:] |
|
34 |
||
35 |
" |
|
36 |
! ! |
|
37 |
||
38 |
!ReportSourceInfo class methodsFor:'instance creation'! |
|
39 |
||
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
40 |
forClass: class inPackage: package |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
41 |
^ ReportClassSourceInfo new initializeWithPackage:package class:class. |
168 | 42 |
|
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
43 |
"Created: / 29-07-2013 / 18:36:35 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
44 |
! |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
45 |
|
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
46 |
forExtensionsInPackage: package |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
47 |
^ ReportExtensionsSourceInfo new initializeWithPackage: package |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
48 |
|
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
49 |
"Created: / 29-07-2013 / 18:37:01 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
168 | 50 |
! ! |
51 |
||
52 |
!ReportSourceInfo methodsFor:'initialization'! |
|
53 |
||
54 |
setup |
|
55 |
"To be called after class is set" |
|
56 |
||
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
57 |
| stream | |
168 | 58 |
|
59 |
stream := LineCountingStream new. |
|
60 |
offsets := Dictionary new. |
|
61 |
||
62 |
[ |
|
63 |
self fileOutOn: stream. |
|
64 |
] on: AbstractSourceFileWriter methodSourceRewriteQuery do:[:rewriteQuery | |
|
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
65 |
| m p | |
168 | 66 |
|
67 |
m := rewriteQuery method. |
|
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
68 |
offsets at: m put: stream position. |
168 | 69 |
rewriteQuery proceed. |
70 |
]. |
|
194
cea07153d29c
Builder::ReportSourceInfo>>#setup
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
168
diff
changeset
|
71 |
lineEnds := stream lineEnds. |
cea07153d29c
Builder::ReportSourceInfo>>#setup
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
168
diff
changeset
|
72 |
|
cea07153d29c
Builder::ReportSourceInfo>>#setup
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
168
diff
changeset
|
73 |
"/Now, check if all is correct... |
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
74 |
"/ offsets keysAndValuesDo:[:method :offset | |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
75 |
"/ sourceF := method package == klass package |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
76 |
"/ ifTrue:[(Smalltalk getPackageDirectoryForPackage: klass package) / ((Smalltalk fileNameForClass: klass) , '.st')] |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
77 |
"/ ifFalse:[(Smalltalk getPackageDirectoryForPackage: method package) / 'extensions.st']. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
78 |
"/ sourceF readingFileDo:[:sourceS| |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
79 |
"/ | source | |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
80 |
"/ |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
81 |
"/ sourceS position: offset. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
82 |
"/ source := sourceS nextChunk. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
83 |
"/"/ self assert: method source = source. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
84 |
"/ ] |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
85 |
"/ ]. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
86 |
self validate. |
194
cea07153d29c
Builder::ReportSourceInfo>>#setup
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
168
diff
changeset
|
87 |
|
cea07153d29c
Builder::ReportSourceInfo>>#setup
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
168
diff
changeset
|
88 |
|
cea07153d29c
Builder::ReportSourceInfo>>#setup
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
168
diff
changeset
|
89 |
|
168 | 90 |
|
91 |
" |
|
194
cea07153d29c
Builder::ReportSourceInfo>>#setup
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
168
diff
changeset
|
92 |
ReportSourceInfo for: Builder::ReportRunner |
168 | 93 |
" |
94 |
||
95 |
"Created: / 01-03-2013 / 17:30:58 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
96 |
"Modified: / 29-07-2013 / 18:20:23 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
168 | 97 |
! ! |
98 |
||
99 |
!ReportSourceInfo methodsFor:'queries'! |
|
100 |
||
101 |
lineAndColumnOfOffset: offset |
|
102 |
| low high middle element line col | |
|
103 |
||
104 |
low := 1. |
|
105 |
high := lineEnds size. |
|
106 |
[low > high] whileFalse:[ |
|
107 |
middle := (low + high) // 2. |
|
108 |
element := lineEnds at:middle. |
|
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
109 |
element <= offset ifTrue:[ |
168 | 110 |
"middleelement is smaller than object" |
111 |
low := middle + 1 |
|
112 |
] ifFalse:[ |
|
113 |
high := middle - 1 |
|
114 |
] |
|
115 |
]. |
|
116 |
||
117 |
line := low. |
|
118 |
col := offset - (line > 1 ifTrue:[lineEnds at: line - 1] ifFalse:[0]). |
|
119 |
^line @ col. |
|
120 |
||
121 |
"Created: / 03-03-2013 / 10:50:34 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
122 |
"Modified: / 29-07-2013 / 18:21:42 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
168 | 123 |
! |
124 |
||
125 |
offsetOfMethod: aMethod |
|
126 |
^offsets at: aMethod |
|
127 |
||
128 |
"Created: / 03-03-2013 / 10:49:40 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
129 |
! ! |
|
130 |
||
131 |
!ReportSourceInfo methodsFor:'utilities'! |
|
132 |
||
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
133 |
fileOutOn:arg |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
134 |
"raise an error: must be redefined in concrete subclass(es)" |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
135 |
|
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
136 |
^ self subclassResponsibility |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
137 |
! |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
138 |
|
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
139 |
validate |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
140 |
^ self subclassResponsibility |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
141 |
|
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
142 |
"Created: / 29-07-2013 / 14:52:22 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
143 |
! |
168 | 144 |
|
200
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
145 |
validateAgainstReference: referenceFile |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
146 |
|
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
147 |
referenceFile readingFileDo:[:sourceS| |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
148 |
offsets keysAndValuesDo:[:method :offset | |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
149 |
| source | |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
150 |
|
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
151 |
sourceS position: offset. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
152 |
source := sourceS nextChunk. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
153 |
"/ self assert: method source = source. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
154 |
] |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
155 |
]. |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
156 |
|
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
157 |
"Created: / 29-07-2013 / 14:52:51 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
e35a3f4b586b
Temporary commit - improved line coverage reporting.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
194
diff
changeset
|
158 |
"Modified: / 29-07-2013 / 19:20:40 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
168 | 159 |
! ! |
160 |
||
161 |
!ReportSourceInfo::LineCountingStream class methodsFor:'instance creation'! |
|
162 |
||
163 |
new |
|
164 |
"return an initialized instance" |
|
165 |
||
166 |
^ self basicNew initialize. |
|
167 |
! ! |
|
168 |
||
169 |
!ReportSourceInfo::LineCountingStream methodsFor:'accessing'! |
|
170 |
||
171 |
contents |
|
172 |
"return the entire contents of the stream. |
|
173 |
For a readStream, that is the rest (i.e. upToEnd), |
|
174 |
for a writeStream, that is the collected data. As we do not know here, |
|
175 |
what we are, this is the responsibility of a subclass..." |
|
176 |
||
177 |
^ self shouldNotImplement |
|
178 |
||
179 |
"Modified: / 01-03-2013 / 17:36:51 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
180 |
! |
|
181 |
||
182 |
lineEnds |
|
183 |
^ lineEnds |
|
184 |
! |
|
185 |
||
186 |
position |
|
187 |
^ position |
|
188 |
! ! |
|
189 |
||
190 |
!ReportSourceInfo::LineCountingStream methodsFor:'initialization'! |
|
191 |
||
192 |
initialize |
|
193 |
"Invoked when a new instance is created." |
|
194 |
||
195 |
"/ please change as required (and remove this comment) |
|
196 |
position := 0. |
|
197 |
lineEnds := OrderedCollection new. |
|
198 |
||
199 |
"/ super initialize. -- commented since inherited method does nothing |
|
200 |
||
201 |
"Modified: / 01-03-2013 / 17:39:38 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
202 |
! ! |
|
203 |
||
204 |
!ReportSourceInfo::LineCountingStream methodsFor:'queries'! |
|
205 |
||
206 |
isReadable |
|
207 |
"return true, if reading is supported by the recevier. |
|
208 |
This has to be redefined in concrete subclasses." |
|
209 |
||
210 |
^ false |
|
211 |
||
212 |
"Modified: / 01-03-2013 / 17:36:58 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
213 |
! |
|
214 |
||
215 |
isWritable |
|
216 |
"return true, if writing is supported by the recevier. |
|
217 |
This has to be redefined in concrete subclasses." |
|
218 |
||
219 |
^ true |
|
220 |
||
221 |
"Modified: / 01-03-2013 / 17:37:07 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
222 |
! |
|
223 |
||
224 |
size |
|
225 |
"return the number of elements in the streamed collection." |
|
226 |
||
227 |
^ self shouldImplement |
|
228 |
! ! |
|
229 |
||
230 |
!ReportSourceInfo::LineCountingStream methodsFor:'reading'! |
|
231 |
||
232 |
next |
|
233 |
"return the next element of the stream |
|
234 |
- we do not know here how to do it, it must be redefined in subclass" |
|
235 |
||
236 |
^ self shouldNotImplement |
|
237 |
||
238 |
"Modified: / 01-03-2013 / 17:37:21 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
239 |
! ! |
|
240 |
||
241 |
!ReportSourceInfo::LineCountingStream methodsFor:'testing'! |
|
242 |
||
243 |
atEnd |
|
244 |
"return true if the end of the stream has been reached; |
|
245 |
- we do not know here how to do it, it must be redefined in subclass" |
|
246 |
||
247 |
^ false |
|
248 |
||
249 |
"Modified: / 01-03-2013 / 17:37:27 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
250 |
! |
|
251 |
||
252 |
isEmpty |
|
253 |
"return true, if the contents of the stream is empty" |
|
254 |
||
255 |
^ self shouldNotImplement |
|
256 |
||
257 |
"Modified: / 01-03-2013 / 17:37:32 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
258 |
! ! |
|
259 |
||
260 |
!ReportSourceInfo::LineCountingStream methodsFor:'writing'! |
|
261 |
||
262 |
nextPut:aCharacter |
|
263 |
"put the argument, anObject onto the receiver |
|
264 |
- we do not know here how to do it, it must be redefined in subclass" |
|
265 |
||
266 |
position := position + 1. |
|
267 |
aCharacter == Character cr ifTrue:[ |
|
268 |
lineEnds add: position |
|
269 |
]. |
|
270 |
||
271 |
"Modified: / 01-03-2013 / 17:39:52 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
272 |
! ! |
|
273 |
||
274 |
!ReportSourceInfo class methodsFor:'documentation'! |
|
275 |
||
276 |
version |
|
277 |
^ '$Header$' |
|
278 |
! |
|
279 |
||
280 |
version_CVS |
|
281 |
^ '$Header$' |
|
282 |
! ! |
|
283 |