1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
FindBugs - Find bugs in Java programs
Copyright (C) 2004,2005 University of Maryland
Copyright (C) 2005, Chris Nappin
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<!--
A simple XSLT stylesheet to transform FindBugs XML results
annotated with messages into HTML.
If you want to experiment with modifying this stylesheet,
or write your own, you need to generate XML output from FindBugs
using a special option which lets it know to include
human-readable messages in the XML. Invoke the findbugs script
as follows:
findbugs -textui -xml:withMessages -project myProject.fb > results.xml
Then you can use your favorite XSLT implementation to transform
the XML output into HTML. (But don't use xsltproc. It generates well-nigh
unreadable output, and generates incorrect output for the
<script> element.)
Authors:
David Hovemeyer
Chris Nappin (summary table)
-->
<xsl:stylesheet
version="1.0"
xmlns="http://www.w3.org/1999/xhtml"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output
method="xml"
indent="yes"
omit-xml-declaration="yes"
standalone="yes"
doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
encoding="UTF-8"/>
<xsl:variable name="literalNbsp">&nbsp;</xsl:variable>
<!--xsl:key name="bug-category-key" match="/BugCollection/BugInstance" use="@category"/-->
<xsl:variable name="bugTableHeader">
<tr class="tableheader">
<th align="left">Code</th>
<th align="left">Warning</th>
</tr>
</xsl:variable>
<xsl:template match="/">
<html>
<head>
<title>FindBugs Report</title>
<style type="text/css">
.tablerow0 {
background: #EEEEEE;
}
.tablerow1 {
background: white;
}
.detailrow0 {
background: #EEEEEE;
}
.detailrow1 {
background: white;
}
.tableheader {
background: #b9b9fe;
font-size: larger;
}
.tablerow0:hover, .tablerow1:hover {
background: #aaffaa;
}
.priority-1 {
color: red;
font-weight: bold;
}
.priority-2 {
color: orange;
font-weight: bold;
}
.priority-3 {
color: green;
font-weight: bold;
}
.priority-4 {
color: blue;
font-weight: bold;
}
</style>
<script type="text/javascript">
function toggleRow(elid) {
if (document.getElementById) {
element = document.getElementById(elid);
if (element) {
if (element.style.display == 'none') {
element.style.display = 'block';
//window.status = 'Toggle on!';
} else {
element.style.display = 'none';
//window.status = 'Toggle off!';
}
}
}
}
</script>
</head>
<xsl:variable name="unique-catkey" select="/BugCollection/BugCategory/@category"/>
<!--xsl:variable name="unique-catkey" select="/BugCollection/BugInstance[generate-id() = generate-id(key('bug-category-key',@category))]/@category"/-->
<body>
<h1><a href="http://findbugs.sourceforge.net">FindBugs</a> Report</h1>
<h2>Project Information</h2>
<xsl:apply-templates select="/BugCollection/Project"/>
<h2>Metrics</h2>
<xsl:apply-templates select="/BugCollection/FindBugsSummary"/>
<h2>Contents</h2>
<ul>
<xsl:for-each select="$unique-catkey">
<xsl:sort select="." order="ascending"/>
<xsl:variable name="catkey" select="."/>
<xsl:variable name="catdesc" select="/BugCollection/BugCategory[@category=$catkey]/Description"/>
<li><a href="#Warnings_{$catkey}"><xsl:value-of select="$catdesc"/> Warnings</a></li>
</xsl:for-each>
<li><a href="#Details">Details</a></li>
</ul>
<h1>Summary</h1>
<table width="500" cellpadding="5" cellspacing="2">
<tr class="tableheader">
<th align="left">Warning Type</th>
<th align="right">Number</th>
</tr>
<xsl:for-each select="$unique-catkey">
<xsl:sort select="." order="ascending"/>
<xsl:variable name="catkey" select="."/>
<xsl:variable name="catdesc" select="/BugCollection/BugCategory[@category=$catkey]/Description"/>
<xsl:variable name="styleclass">
<xsl:choose><xsl:when test="position() mod 2 = 1">tablerow0</xsl:when>
<xsl:otherwise>tablerow1</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<tr class="{$styleclass}">
<td><a href="#Warnings_{$catkey}"><xsl:value-of select="$catdesc"/> Warnings</a></td>
<td align="right"><xsl:value-of select="count(/BugCollection/BugInstance[(@category=$catkey) and not(@last)])"/></td>
</tr>
</xsl:for-each>
<xsl:variable name="styleclass">
<xsl:choose><xsl:when test="count($unique-catkey) mod 2 = 0">tablerow0</xsl:when>
<xsl:otherwise>tablerow1</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<tr class="{$styleclass}">
<td><b>Total</b></td>
<td align="right"><b><xsl:value-of select="count(/BugCollection/BugInstance[not(@last)])"/></b></td>
</tr>
</table>
<h1>Warnings</h1>
<p>Click on a warning row to see full context information.</p>
<xsl:for-each select="$unique-catkey">
<xsl:sort select="." order="ascending"/>
<xsl:variable name="catkey" select="."/>
<xsl:variable name="catdesc" select="/BugCollection/BugCategory[@category=$catkey]/Description"/>
<xsl:call-template name="generateWarningTable">
<xsl:with-param name="warningSet" select="/BugCollection/BugInstance[(@category=$catkey) and not(@last)]"/>
<xsl:with-param name="sectionTitle"><xsl:value-of select="$catdesc"/> Warnings</xsl:with-param>
<xsl:with-param name="sectionId">Warnings_<xsl:value-of select="$catkey"/></xsl:with-param>
</xsl:call-template>
</xsl:for-each>
<h1><a name="Details">Details</a></h1>
<xsl:apply-templates select="/BugCollection/BugPattern">
<xsl:sort select="@abbrev"/>
<xsl:sort select="ShortDescription"/>
</xsl:apply-templates>
</body>
</html>
</xsl:template>
<xsl:template match="Project">
<p>Project:
<xsl:choose>
<xsl:when test='string-length(/BugCollection/Project/@projectName)>0'><xsl:value-of select="/BugCollection/Project/@projectName" /></xsl:when>
<xsl:otherwise><xsl:value-of select="/BugCollection/Project/@filename" /></xsl:otherwise>
</xsl:choose>
</p>
<p>FindBugs version: <xsl:value-of select="/BugCollection/@version"/></p>
<p>Code analyzed:</p>
<ul>
<xsl:for-each select="./Jar">
<li><xsl:value-of select="text()"/></li>
</xsl:for-each>
</ul>
<p><br/><br/></p>
</xsl:template>
<xsl:template match="BugInstance[not(@last)]">
<xsl:variable name="warningId"><xsl:value-of select="generate-id()"/></xsl:variable>
<tr class="tablerow{position() mod 2}" onclick="toggleRow('{$warningId}');">
<td>
<span><xsl:attribute name="class">priority-<xsl:value-of select="@priority"/></xsl:attribute>
<xsl:value-of select="@abbrev"/>
</span>
</td>
<td>
<xsl:value-of select="LongMessage"/>
</td>
</tr>
<!-- Add bug annotation elements: Class, Method, Field, SourceLine, Field -->
<tr class="detailrow{position() mod 2}">
<td/>
<td>
<p id="{$warningId}" style="display: none;">
<a href="#{@type}">Bug type <xsl:value-of select="@type"/> (click for details)</a>
<xsl:for-each select="./*/Message">
<br/><xsl:value-of select="text()" disable-output-escaping="no"/>
</xsl:for-each>
</p>
</td>
</tr>
</xsl:template>
<xsl:template match="BugPattern">
<h2><a name="{@type}"><xsl:value-of select="@type"/>: <xsl:value-of select="ShortDescription"/></a></h2>
<xsl:value-of select="Details" disable-output-escaping="yes"/>
</xsl:template>
<xsl:template name="generateWarningTable">
<xsl:param name="warningSet"/>
<xsl:param name="sectionTitle"/>
<xsl:param name="sectionId"/>
<h2><a name="{$sectionId}"><xsl:value-of select="$sectionTitle"/></a></h2>
<table class="warningtable" width="100%" cellspacing="0">
<xsl:copy-of select="$bugTableHeader"/>
<xsl:apply-templates select="$warningSet">
<xsl:sort select="@abbrev"/>
<xsl:sort select="Class/@classname"/>
</xsl:apply-templates>
</table>
</xsl:template>
<xsl:template match="FindBugsSummary">
<xsl:variable name="kloc" select="@total_size div 1000.0"/>
<xsl:variable name="format" select="'#######0.00'"/>
<p><xsl:value-of select="@total_size"/> lines of code analyzed,
in <xsl:value-of select="@total_classes"/> classes,
in <xsl:value-of select="@num_packages"/> packages.</p>
<table width="500" cellpadding="5" cellspacing="2">
<tr class="tableheader">
<th align="left">Metric</th>
<th align="right">Total</th>
<th align="right">Density*</th>
</tr>
<tr class="tablerow0">
<td>High Priority Warnings</td>
<td align="right"><xsl:value-of select="@priority_1"/></td>
<td align="right">
<xsl:choose>
<xsl:when test= "number($kloc) > 0.0 and number(@priority_1) > 0.0">
<xsl:value-of select="format-number(@priority_1 div $kloc, $format)"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="format-number(0.0, $format)"/>
</xsl:otherwise>
</xsl:choose>
</td>
</tr>
<tr class="tablerow1">
<td>Medium Priority Warnings</td>
<td align="right"><xsl:value-of select="@priority_2"/></td>
<td align="right">
<xsl:choose>
<xsl:when test= "number($kloc) > 0.0 and number(@priority_2) > 0.0">
<xsl:value-of select="format-number(@priority_2 div $kloc, $format)"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="format-number(0.0, $format)"/>
</xsl:otherwise>
</xsl:choose>
</td>
</tr>
<xsl:choose>
<xsl:when test="@priority_3">
<tr class="tablerow1">
<td>Low Priority Warnings</td>
<td align="right"><xsl:value-of select="@priority_3"/></td>
<td align="right">
<xsl:choose>
<xsl:when test= "number($kloc) > 0.0 and number(@priority_3) > 0.0">
<xsl:value-of select="format-number(@priority_3 div $kloc, $format)"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="format-number(0.0, $format)"/>
</xsl:otherwise>
</xsl:choose>
</td>
</tr>
<xsl:variable name="totalClass" select="tablerow0"/>
</xsl:when>
<xsl:otherwise>
<xsl:variable name="totalClass" select="tablerow1"/>
</xsl:otherwise>
</xsl:choose>
<tr class="$totalClass">
<td><b>Total Warnings</b></td>
<td align="right"><b><xsl:value-of select="@total_bugs"/></b></td>
<xsl:choose>
<xsl:when test="number($kloc) > 0.0">
<td align="right"><b><xsl:value-of select="format-number(@total_bugs div $kloc, $format)"/></b></td>
</xsl:when>
<xsl:otherwise>
<td align="right"><b><xsl:value-of select="format-number(0.0, $format)"/></b></td>
</xsl:otherwise>
</xsl:choose>
</tr>
</table>
<p><i>(* Defects per Thousand lines of non-commenting source statements)</i></p>
<p><br/><br/></p>
</xsl:template>
</xsl:stylesheet>
<!-- vim:set ts=4: -->
|
