walkero
/
cppcheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
cppcheck/htmlreport/cppcheck-htmlreport

332 lines
10 KiB
Plaintext
Raw Normal View History

Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
#!/usr/bin/env python
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
import sys
import optparse
import os
from pygments import highlight
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
from pygments.lexers import guess_lexer_for_filename
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
from pygments.formatters import HtmlFormatter
from xml.sax import parse as xml_parse
from xml.sax import SAXParseException as XmlParseException
from xml.sax.handler import ContentHandler as XmlContentHandler
"""
Turns a cppcheck xml file into a browsable html report along
with syntax highlighted source code.
"""
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
STYLE_FILE = """
body.body {
font-family: Arial;
font-size: 13px;
background-color: black;
padding: 0px;
margin: 0px;
}
Highlight errors to make them obvious
2012-09-15 22:41:56 +02:00
.error {
font-family: Arial;
font-size: 13px;
background-color: #ffb7b7;
padding: 0px;
margin: 0px;
}
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
#page-header {
clear: both;
width: 900px;
margin: 20px auto 0px auto;
height: 10px;
border-bottom-width: 2px;
border-bottom-style: solid;
border-bottom-color: #aaaaaa;
}
#page {
width: 860px;
margin: auto;
border-left-width: 2px;
border-left-style: solid;
border-left-color: #aaaaaa;
border-right-width: 2px;
border-right-style: solid;
border-right-color: #aaaaaa;
background-color: White;
padding: 20px;
}
#page-footer {
clear: both;
width: 900px;
margin: auto;
height: 10px;
border-top-width: 2px;
border-top-style: solid;
border-top-color: #aaaaaa;
}
#header {
width: 100%;
height: 70px;
background-image: url(logo.png);
background-repeat: no-repeat;
background-position: left top;
border-bottom-style: solid;
border-bottom-width: thin;
border-bottom-color: #aaaaaa;
}
#menu {
margin-top: 5px;
text-align: left;
float: left;
width: 100px;
height: 300px;
}
#menu > a {
margin-left: 10px;
display: block;
}
#content {
float: left;
width: 720px;
margin: 5px;
padding: 0px 10px 10px 10px;
border-left-style: solid;
border-left-width: thin;
border-left-color: #aaaaaa;
}
#footer {
padding-bottom: 5px;
padding-top: 5px;
border-top-style: solid;
border-top-width: thin;
border-top-color: #aaaaaa;
clear: both;
font-size: 10px;
}
#footer > div {
float: left;
width: 33%;
}
"""
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
HTML_HEAD = """
Added !DOCTYPE declaration for html generated by the cppcheck-htmlreport tool.
2010-01-13 14:01:45 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
<html>
<head>
cppcheck-htmlreport now takes a --title parameter that will be displayed on top of every page.
2010-01-13 14:11:54 +01:00
<title>CppCheck - Html report - %s</title>
Added !DOCTYPE declaration for html generated by the cppcheck-htmlreport tool.
2010-01-13 14:01:45 +01:00
<link href="style.css" rel="stylesheet" type="text/css" />
Fixed some markup errors in generated html from the cppcheck-htmlreport script.
2010-01-12 20:34:55 +01:00
<style type="text/css">
%s
</style>
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
</head>
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
<body class="body">
<div id="page-header">
&nbsp;
</div>
<div id="page">
<div id="header">
cppcheck-htmlreport now takes a --title parameter that will be displayed on top of every page.
2010-01-13 14:11:54 +01:00
<h1>CppCheck report - %s</h1>
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
</div>
<div id="menu">
<a href="index.html">Defect list</a>
</div>
<div id="content">
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
"""
HTML_FOOTER = """
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
</div>
<div id="footer">
<div>
CppCheck - a tool for static C/C++ code analysis
</div>
<div>
Internet: <a href="http://cppcheck.sourceforge.net">http://cppcheck.sourceforge.net</a><br/>
Forum: <a href="http://apps.sourceforge.net/phpbb/cppcheck/">http://apps.sourceforge.net/phpbb/cppcheck/</a><br/>
IRC: #cppcheck at irc.freenode.net
</div>
&nbsp;
</div>
&nbsp;
</div>
<div id="page-footer">
&nbsp;
</div>
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
</body>
</html>
"""
cppcheck-htmlreport now annotates the highlighted source code with the cppcheck error message.
2010-01-12 21:35:54 +01:00
HTML_ERROR = "<span style=\"border-width: 2px;border-color: black;border-style: solid;background: #ffaaaa;padding: 3px;\">&lt;--- %s</span>\n"
class AnnotateCodeFormatter(HtmlFormatter):
errors = []
def wrap(self, source, outfile):
line_no = 1
for i, t in HtmlFormatter.wrap(self, source, outfile):
# If this is a source code line we want to add a span tag at the end.
if i == 1:
for error in self.errors:
if error["line"] == line_no:
t = t.replace("\n", HTML_ERROR % error["msg"])
line_no = line_no + 1
yield i, t
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
class CppCheckHandler(XmlContentHandler):
"""Parses the cppcheck xml file and produces a list of all its errors."""
errors = []
def startElement(self, name, attributes):
if name != "error":
return
Fixed #3057 (cppcheck-htmlreport fails since 1.50)
2011-08-30 20:30:52 +02:00
if attributes["id"] == "missingInclude":
self.errors.append(
{
"file" : "",
"line" : 0,
"id" : attributes["id"],
"severity" : attributes["severity"],
"msg" : attributes["msg"]
})
else:
if attributes["file"] == "":
sys.stderr.write("ERROR: cppcheck error reported without a file name.\n")
self.errors.append(
{
"file" : attributes["file"],
"line" : int(attributes["line"]),
"id" : attributes["id"],
"severity" : attributes["severity"],
"msg" : attributes["msg"]
})
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
if __name__ == '__main__':
# Configure all the options this little utility is using.
parser = optparse.OptionParser()
cppcheck-htmlreport now takes a --title parameter that will be displayed on top of every page.
2010-01-13 14:11:54 +01:00
parser.add_option("--title", dest="title", help="The title of the project.", default="[project name]")
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
parser.add_option("--file", dest="file", help="The cppcheck xml output file to read defects from. Default is reading from stdin.")
parser.add_option("--report-dir", dest="report_dir", help="The directory where the html report content is written.")
parser.add_option("--source-dir", dest="source_dir", help="Base directory where source code files can be found.")
cppcheck-htmlreport now takes a parameter for source code encoding to support non ascii characters. Also present a nicer error message if highlighting fail for a file.
2010-01-14 09:47:38 +01:00
parser.add_option("--source-encoding", dest="source_encoding", help="Encoding of source code.", default=None)
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
# Parse options and make sure that we have an output directory set.
options, args = parser.parse_args()
if not options.report_dir:
parser.error("No report directory set.")
# Get the directory where source code files are located.
source_dir = os.getcwd()
if options.source_dir:
source_dir = options.source_dir
# Get the stream that we read cppcheck errors from.
stream = sys.stdin
if options.file:
if os.path.exists(options.file) == False:
parser.error("cppcheck xml file: %s not found." % options.file)
stream = open(options.file, "r")
# Parse the xml file and produce a simple list of errors.
print("Parsing xml report.")
try:
contentHandler = CppCheckHandler()
xml_parse(stream, contentHandler)
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
except XmlParseException as msg:
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
print("Failed to parse cppcheck xml file: %s" % msg)
sys.exit(1)
# We have a list of errors. But now we want to group them on
# each source code file. Lets create a files dictionary that
# will contain a list of all the errors in that file. For each
# file we will also generate a html filename to use.
files = {}
file_no = 0
for error in contentHandler.errors:
filename = error["file"]
if filename not in files.keys():
files[filename] = { "errors" : [], "htmlfile" : str(file_no) + ".html" }
file_no = file_no + 1
files[filename]["errors"].append(error)
# Make sure that the report directory is created if it doesn't exist.
print("Creating %s directory" % options.report_dir)
if not os.path.exists(options.report_dir):
os.mkdir(options.report_dir)
# Generate a html file with syntax highlighted source code for each
# file that contains one or more errors.
print("Processing errors")
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
for filename, data in files.items():
cppcheck-htmlreport now takes a parameter for source code encoding to support non ascii characters. Also present a nicer error message if highlighting fail for a file.
2010-01-14 09:47:38 +01:00
try:
htmlfile = data["htmlfile"]
errors = data["errors"]
lines = []
for error in errors:
lines.append(error["line"])
Fixed #3057 (cppcheck-htmlreport fails since 1.50)
2011-08-30 20:30:52 +02:00
if filename == "":
continue
cppcheck-htmlreport now takes a parameter for source code encoding to support non ascii characters. Also present a nicer error message if highlighting fail for a file.
2010-01-14 09:47:38 +01:00
source_file = os.path.join(source_dir, filename)
if not os.path.isfile(source_file):
sys.stderr.write("ERROR: Source file '%s' not found.\n" % source_file)
continue
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
stream = open(source_file)
cppcheck-htmlreport now takes a parameter for source code encoding to support non ascii characters. Also present a nicer error message if highlighting fail for a file.
2010-01-14 09:47:38 +01:00
content = stream.read()
stream.close()
htmlFormatter = AnnotateCodeFormatter(linenos=True, style='colorful', hl_lines=lines, lineanchors="line", encoding=options.source_encoding)
htmlFormatter.errors = errors
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
stream = open(os.path.join(options.report_dir, htmlfile), "w")
cppcheck-htmlreport now takes a parameter for source code encoding to support non ascii characters. Also present a nicer error message if highlighting fail for a file.
2010-01-14 09:47:38 +01:00
stream.write(HTML_HEAD % (options.title, htmlFormatter.get_style_defs(".highlight"), options.title))
html report: better handling of non ASCII characters in C source code
2011-04-16 11:22:44 +02:00
lexer = guess_lexer_for_filename(source_file, "")
if options.source_encoding:
lexer.encoding = options.source_encoding
stream.write(highlight(content, lexer, htmlFormatter))
cppcheck-htmlreport now takes a parameter for source code encoding to support non ascii characters. Also present a nicer error message if highlighting fail for a file.
2010-01-14 09:47:38 +01:00
stream.write(HTML_FOOTER)
stream.close()
print(" " + filename)
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
except Exception as message:
cppcheck-htmlreport now takes a parameter for source code encoding to support non ascii characters. Also present a nicer error message if highlighting fail for a file.
2010-01-14 09:47:38 +01:00
print("ERROR: Filename: %s, %s" % (filename, message))
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
# Generate a master index.html file that will contain a list of
# all the errors created.
print("Creating index.html")
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
stream = open(os.path.join(options.report_dir, "index.html"), "w")
cppcheck-htmlreport now takes a --title parameter that will be displayed on top of every page.
2010-01-13 14:11:54 +01:00
stream.write(HTML_HEAD % (options.title, "", options.title))
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
stream.write("<table>")
stream.write("<tr><th>Line</th><th>Id</th><th>Severity</th><th>Message</th></tr>")
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
for filename, data in files.items():
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
stream.write("<tr><td colspan='4'><a href=\"%s\">%s</a></td></tr>" % (data["htmlfile"], filename))
for error in data["errors"]:
Highlight errors to make them obvious
2012-09-15 22:41:56 +02:00
if error['severity'] == 'error':
error_class = 'class="error"'
else:
error_class = ''
Fixed #3057 (cppcheck-htmlreport fails since 1.50)
2011-08-30 20:30:52 +02:00
if error["id"] == "missingInclude":
stream.write("<tr><td></td><td>%s</td><td>%s</td><td>%s</td></tr>" %
(error["id"], error["severity"], error["msg"]))
else:
Highlight errors to make them obvious
2012-09-15 22:41:56 +02:00
stream.write("<tr><td><a href='%s#line-%d'>%d</a></td><td>%s</td><td>%s</td><td %s>%s</td></tr>" %
Fixed #3057 (cppcheck-htmlreport fails since 1.50)
2011-08-30 20:30:52 +02:00
(data["htmlfile"], error["line"], error["line"], error["id"],
Highlight errors to make them obvious
2012-09-15 22:41:56 +02:00
error["severity"], error_class, error["msg"]))
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
stream.write("</table>")
Added a python script that takes the cppcheck output xml file and generates a html report of it. The html report is complete with syntax highlighted source code using the pygments module. This initial commit contains generation of html files but the actual errors is missing from the html content and the index.html file.
2009-12-08 21:09:21 +01:00
stream.write(HTML_FOOTER)
stream.close()
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
print("Creating style.css file")
Add Python 3 compatibility Maintain backward compatibility with Python 2.6 and 2.7.
2012-09-07 18:44:46 +02:00
stream = open(os.path.join(options.report_dir, "style.css"), "w")
index.html page is now complete with a list of files and all errors found. Other changes: * added a stylesheet and made the html design much better. * contains links directly to the line in the source file.
2009-12-11 12:39:39 +01:00
stream.write(STYLE_FILE)
stream.close()