PyPI - cppcheck-py - Versions diffs - 2.19.0__py3-none-win32.whl - Mend

cppcheck-py 2.19.0__py3-none-win32.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (84) hide show

cppcheck/__init__.py +55 -0
cppcheck/cppcheck-2.19.0.tar.gz +0 -0
cppcheck/data/addons/__init__.py +0 -0
cppcheck/data/addons/cppcheck.py +41 -0
cppcheck/data/addons/cppcheckdata.py +1727 -0
cppcheck/data/addons/findcasts.py +32 -0
cppcheck/data/addons/misc.py +163 -0
cppcheck/data/addons/misra.py +5153 -0
cppcheck/data/addons/misra_9.py +559 -0
cppcheck/data/addons/naming.py +92 -0
cppcheck/data/addons/namingng.py +420 -0
cppcheck/data/addons/runaddon.py +16 -0
cppcheck/data/addons/threadsafety.py +350 -0
cppcheck/data/addons/y2038.py +602 -0
cppcheck/data/cfg/avr.cfg +402 -0
cppcheck/data/cfg/bento4.cfg +142 -0
cppcheck/data/cfg/boost.cfg +1284 -0
cppcheck/data/cfg/bsd.cfg +567 -0
cppcheck/data/cfg/cairo.cfg +89 -0
cppcheck/data/cfg/cppcheck-lib.cfg +72 -0
cppcheck/data/cfg/cppunit.cfg +48 -0
cppcheck/data/cfg/dpdk.cfg +11 -0
cppcheck/data/cfg/embedded_sql.cfg +4 -0
cppcheck/data/cfg/emscripten.cfg +108 -0
cppcheck/data/cfg/ginac.cfg +12848 -0
cppcheck/data/cfg/gnu.cfg +1738 -0
cppcheck/data/cfg/googletest.cfg +62 -0
cppcheck/data/cfg/gtk.cfg +23082 -0
cppcheck/data/cfg/icu.cfg +221 -0
cppcheck/data/cfg/kde.cfg +92 -0
cppcheck/data/cfg/libcerror.cfg +203 -0
cppcheck/data/cfg/libcurl.cfg +487 -0
cppcheck/data/cfg/libsigc++.cfg +36 -0
cppcheck/data/cfg/lua.cfg +316 -0
cppcheck/data/cfg/mfc.cfg +271 -0
cppcheck/data/cfg/microsoft_atl.cfg +40 -0
cppcheck/data/cfg/microsoft_sal.cfg +490 -0
cppcheck/data/cfg/microsoft_unittest.cfg +20 -0
cppcheck/data/cfg/motif.cfg +318 -0
cppcheck/data/cfg/nspr.cfg +38 -0
cppcheck/data/cfg/ntl.cfg +6907 -0
cppcheck/data/cfg/opencv2.cfg +132 -0
cppcheck/data/cfg/opengl.cfg +581 -0
cppcheck/data/cfg/openmp.cfg +157 -0
cppcheck/data/cfg/openssl.cfg +174 -0
cppcheck/data/cfg/pcre.cfg +165 -0
cppcheck/data/cfg/posix.cfg +6445 -0
cppcheck/data/cfg/protobuf.cfg +10 -0
cppcheck/data/cfg/python.cfg +674 -0
cppcheck/data/cfg/qt.cfg +5502 -0
cppcheck/data/cfg/ruby.cfg +142 -0
cppcheck/data/cfg/sdl.cfg +354 -0
cppcheck/data/cfg/selinux.cfg +3621 -0
cppcheck/data/cfg/sfml.cfg +301 -0
cppcheck/data/cfg/sqlite3.cfg +1571 -0
cppcheck/data/cfg/std.cfg +9205 -0
cppcheck/data/cfg/tinyxml2.cfg +37 -0
cppcheck/data/cfg/vcl.cfg +4 -0
cppcheck/data/cfg/windows.cfg +17237 -0
cppcheck/data/cfg/wxsqlite3.cfg +1955 -0
cppcheck/data/cfg/wxsvg.cfg +16905 -0
cppcheck/data/cfg/wxwidgets.cfg +17245 -0
cppcheck/data/cfg/zephyr.cfg +113 -0
cppcheck/data/cfg/zlib.cfg +1450 -0
cppcheck/data/cppcheck-htmlreport +1157 -0
cppcheck/data/cppcheck.exe +0 -0
cppcheck/data/platforms/aix_ppc64.xml +18 -0
cppcheck/data/platforms/arm32-wchar_t2.xml +18 -0
cppcheck/data/platforms/arm32-wchar_t4.xml +18 -0
cppcheck/data/platforms/arm64-wchar_t2.xml +18 -0
cppcheck/data/platforms/arm64-wchar_t4.xml +18 -0
cppcheck/data/platforms/avr8.xml +18 -0
cppcheck/data/platforms/cray_sv1.xml +18 -0
cppcheck/data/platforms/elbrus-e1cp.xml +18 -0
cppcheck/data/platforms/mips32.xml +18 -0
cppcheck/data/platforms/msp430_eabi_large_datamodel.xml +18 -0
cppcheck/data/platforms/pic16.xml +18 -0
cppcheck/data/platforms/pic8-enhanced.xml +18 -0
cppcheck/data/platforms/pic8.xml +18 -0
cppcheck_py-2.19.0.dist-info/METADATA +76 -0
cppcheck_py-2.19.0.dist-info/RECORD +84 -0
cppcheck_py-2.19.0.dist-info/WHEEL +5 -0
cppcheck_py-2.19.0.dist-info/entry_points.txt +4 -0
cppcheck_py-2.19.0.dist-info/licenses/LICENSE.md +191 -0

cppcheck/data/cppcheck-htmlreport ADDED Viewed

@@ -0,0 +1,1157 @@
+#!/usr/bin/env python3
+from __future__ import unicode_literals
+from datetime import date
+import argparse
+import io
+import locale
+import operator
+import os
+import re
+import sys
+import subprocess
+import time
+from collections import Counter
+from pygments import highlight
+from pygments.lexers import guess_lexer, guess_lexer_for_filename
+from pygments.formatters import HtmlFormatter  # pylint: disable=no-name-in-module
+from pygments.util import ClassNotFound
+from xml.sax import parse as xml_parse
+from xml.sax import SAXParseException as XmlParseException
+from xml.sax.handler import ContentHandler as XmlContentHandler
+from xml.sax.saxutils import escape
+"""
+Turns a cppcheck xml file into a browsable html report along
+with syntax highlighted source code.
+"""
+STYLE_FILE = """
+body {
+    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif;
+    font-size: 13px;
+    line-height: 1.5;
+    height: 100%;
+    margin: 0;
+}
+#wrapper {
+    position: fixed;
+    height: 100vh;
+    width: 100vw;
+    display: grid;
+    grid-template-rows: fit-content(8rem) auto fit-content(8rem);
+    grid-template-columns: fit-content(25%) 1fr;
+    grid-template-areas:
+      "header header"
+      "menu content"
+      "footer footer";
+}
+h1 {
+    margin: 0 0 8px -2px;
+    font-size: 175%;
+}
+.header {
+    padding: 0 0 5px 15px;
+    grid-area: header;
+    border-bottom: thin solid #aaa;
+}
+.footer {
+    grid-area: footer;
+    border-top: thin solid #aaa;
+    font-size: 85%;
+}
+.footer > p {
+    margin: 4px;
+}
+#menu,
+#menu_index {
+    grid-area: menu;
+    text-align: left;
+    overflow: auto;
+    padding: 0 23px 15px 15px;
+    border-right: thin solid #aaa;
+    min-width: 200px;
+}
+#menu > a {
+    display: block;
+    margin-left: 10px;
+    font-size: 12px;
+}
+#content,
+#content_index {
+    grid-area: content;
+    padding: 0px 5px 15px 15px;
+    overflow: auto;
+}
+label {
+    white-space: nowrap;
+}
+label.checkBtn.disabled {
+    color: #606060;
+    background: #e0e0e0;
+    font-style: italic;
+}
+label.checkBtn, input[type="text"] {
+    border: 1px solid grey;
+    border-radius: 4px;
+    box-shadow: 1px 1px inset;
+    padding: 1px 5px;
+}
+label.checkBtn {
+    white-space: nowrap;
+    background: #ccddff;
+}
+label.unchecked {
+    background: #eff8ff;
+    box-shadow: 1px 1px 1px;
+}
+label.checkBtn:hover, label.unchecked:hover{
+    box-shadow: 0 0 2px;
+}
+label.disabled:hover {
+    box-shadow: 1px 1px inset;
+}
+label.checkBtn > input {
+    display:none;
+}
+.summaryTable {
+    width: 100%;
+}
+table.summaryTable td { padding: 0 5px 0 5px; }
+.statHeader, .severityHeader, .classificationHeader {
+    font-weight: bold;
+}
+.warning {
+    background-color: #ffffa7;
+}
+.error {
+    background-color: #ffb7b7;
+}
+.error2 {
+    background-color: #faa;
+    display: inline-block;
+    margin-left: 4px;
+}
+.inconclusive {
+    background-color: #b6b6b4;
+}
+.inconclusive2 {
+    background-color: #b6b6b4;
+    display: inline-block;
+    margin-left: 4px;
+}
+.verbose {
+    display: inline-block;
+    vertical-align: top;
+    cursor: help;
+}
+.verbose .content {
+    display: none;
+    position: absolute;
+    padding: 10px;
+    margin: 4px;
+    max-width: 40%;
+    white-space: pre-wrap;
+    border: 1px solid #000;
+    background-color: #ffffcc;
+    cursor: auto;
+}
+.highlight .hll {
+    padding: 1px;
+}
+.highlighttable {
+    background-color: #fff;
+    position: relative;
+    margin: -10px;
+}
+.linenos {
+    border-right: thin solid #aaa;
+    color: #d3d3d3;
+    padding-right: 6px;
+}
+.id-filtered, .severity-filtered, .classification-filtered, .file-filtered, .tool-filtered, .text-filtered {
+    visibility: collapse;
+}
+"""
+HTML_HEAD = """
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Cppcheck - HTML report - %s</title>
+    <link rel="stylesheet" href="style.css">
+    <style>
+%s
+    </style>
+    <script>
+      function getStyle(el, styleProp) {
+        var y;
+        if (el.currentStyle) {
+          y = el.currentStyle[styleProp];
+        } else if (window.getComputedStyle) {
+          y = document.defaultView.getComputedStyle(el, null).getPropertyValue(styleProp);
+        }
+        return y;
+      }
+      function toggle() {
+        var el = this.expandable_content;
+        var mark = this.expandable_marker;
+        if (el.style.display === "block") {
+          el.style.display = "none";
+          mark.textContent = "[+]";
+        } else {
+          el.style.display = "block";
+          mark.textContent = "[-]";
+        }
+      }
+      function initExpandables() {
+        var elements = document.querySelectorAll(".expandable");
+        for (var i = 0, len = elements.length; i < len; i++) {
+          var el = elements[i];
+          var clickable = el.querySelector("span");
+          var marker = clickable.querySelector(".marker");
+          var content = el.querySelector(".content");
+          var width = clickable.clientWidth - parseInt(getStyle(content, "padding-left")) - parseInt(getStyle(content, "padding-right"));
+          content.style.width = width + "px";
+          clickable.expandable_content = content;
+          clickable.expandable_marker = marker;
+          clickable.addEventListener("click", toggle);
+        }
+      }
+      function toggleDisplay(cb) {
+        var elements = document.querySelectorAll("." + cb.id);
+        for (var i = 0, len = elements.length; i < len; i++) {
+          elements[i].classList.toggle("id-filtered", !cb.checked);
+        }
+        updateFileRows();
+      }
+      function toggleSeverity(cb) {
+        cb.parentElement.classList.toggle("unchecked", !cb.checked);
+        var elements = document.querySelectorAll(".sev_" + cb.id);
+        for (var i = 0, len = elements.length; i < len; i++) {
+          elements[i].classList.toggle("severity-filtered", !cb.checked);
+        }
+        updateFileRows();
+      }
+      function toggleClassification(cb) {
+        cb.parentElement.classList.toggle("unchecked", !cb.checked);
+        var elements = document.querySelectorAll(".class_" + cb.id);
+        for (var i = 0, len = elements.length; i < len; i++) {
+          elements[i].classList.toggle("classification-filtered", !cb.checked);
+        }
+        updateFileRows();
+      }
+      function toggleTool(cb) {
+        cb.parentElement.classList.toggle("unchecked", !cb.checked);
+        var elements;
+        if (cb.id == "clang-tidy")
+            elements = document.querySelectorAll("[class^=clang-tidy-]");
+        else
+            elements = document.querySelectorAll(".issue:not([class^=clang-tidy-])");
+        for (var i = 0, len = elements.length; i < len; i++) {
+          elements[i].classList.toggle("tool-filtered", !cb.checked);
+        }
+        updateFileRows();
+      }
+      function toggleAll() {
+        var elements = document.querySelectorAll(".idToggle");
+        // starting from 1 since 0 is the "toggle all" input
+        for (var i = 1, len = elements.length; i < len; i++) {
+          var changed = elements[i].checked != elements[0].checked;
+          if (changed) {
+            elements[i].checked = elements[0].checked;
+            toggleDisplay(elements[i]);
+          }
+        }
+      }
+      function filterFile(filter) {
+        var elements = document.querySelectorAll(".fileEntry");
+        for (var i = 0, len = elements.length; i < len; i++) {
+          var visible = elements[i].querySelector("tr").querySelector("td").textContent.toLowerCase().includes(filter.toLowerCase());
+          elements[i].classList.toggle("text-filtered", !visible);
+        }
+      }
+      function filterText(text) {
+        filter = text.toLowerCase();
+        var elements = document.querySelectorAll(".issue");
+        for (var i = 0, len = elements.length; i < len; i++) {
+          var visible = false;
+          var fields = elements[i].querySelectorAll("td");
+          for (var n = 0, num = fields.length; n < num; n++) {
+            if (fields[n].textContent.toLowerCase().includes(filter)) {
+              visible = true;
+              break;
+            }
+          }
+          elements[i].classList.toggle("text-filtered", !visible);
+        }
+        updateFileRows();
+      }
+      function updateFileRows(element) {
+        var elements = document.querySelectorAll(".fileEntry");
+        for (var i = 0, len = elements.length; i < len; i++) {
+          var visible = elements[i].querySelector(".issue:not(.id-filtered):not(.severity-filtered):not(.classification-filtered):not(.tool-filtered):not(.text-filtered)");
+          elements[i].classList.toggle("file-filtered", !visible);
+        }
+      }
+      function reapplyFilters() {
+        // Reapply ID filters
+        var idToggles = document.querySelectorAll(".idToggle");
+        for (var i = 1; i < idToggles.length; i++) {
+          var cb = idToggles[i];
+          var elements = document.querySelectorAll("." + cb.id);
+          for (var j = 0; j < elements.length; j++) {
+            elements[j].classList.toggle("id-filtered", !cb.checked);
+          }
+        }
+        // Reapply severity filters
+        var sevToggles = document.querySelectorAll(".sev_toggle");
+        for (var i = 0; i < sevToggles.length; i++) {
+          var cb = sevToggles[i];
+            var elements = document.querySelectorAll(".sev_" + cb.id);
+          for (var j = 0; j < elements.length; j++) {
+            elements[j].classList.toggle("severity-filtered", !cb.checked);
+          }
+        }
+        // Reapply classification filters
+        var classToggles = document.querySelectorAll(".class_toggle");
+        for (var i = 0; i < classToggles.length; i++) {
+          var cb = classToggles[i];
+          var elements = document.querySelectorAll(".class_" + cb.id);
+          for (var j = 0; j < elements.length; j++) {
+            elements[j].classList.toggle("classification-filtered", !cb.checked);
+          }
+        }
+        // Reapply tool filters
+        var toolToggles = document.querySelectorAll(".tool_toggle");
+        for (var i = 0; i < toolToggles.length; i++) {
+          var cb = toolToggles[i];
+          var elements;
+          if (cb.id == "clang-tidy")
+            elements = document.querySelectorAll("[class^=clang-tidy-]");
+          else
+            elements = document.querySelectorAll(".issue:not([class^=clang-tidy-])");
+          for (var j = 0; j < elements.length; j++) {
+            elements[j].classList.toggle("tool-filtered", !cb.checked);
+          }
+        }
+        // Update file rows
+        updateFileRows();
+      }
+      window.addEventListener("pageshow", reapplyFilters);
+      window.addEventListener("load", initExpandables);
+    </script>
+  </head>
+  <body>
+    <div id="wrapper">
+    <div id="header" class="header">
+      <h1>Cppcheck report - %s%s</h1>
+"""
+HTML_HEAD_END = """
+    </div>
+"""
+HTML_MENU = """
+    <div id="menu">
+     <p><a href="index.html">Defects:</a> %s</p>
+"""
+HTML_MENU_END = """
+    </div>
+    <div id="content">
+"""
+HTML_FOOTER = """
+    </div>
+    <div id="footer" class="footer">
+      <p>
+        Created by Cppcheck %s (<a href="https://cppcheck.sourceforge.io">Sourceforge</a>, <a href="irc://irc.libera.chat/#cppcheck">IRC</a>)
+      </p>
+    </div>
+    </div>
+  </body>
+</html>
+"""
+HTML_ERROR = "<span class=\"error2\">&lt;--- %s</span>\n"
+HTML_INCONCLUSIVE = "<span class=\"inconclusive2\">&lt;--- %s</span>\n"
+HTML_EXPANDABLE_ERROR = "<div class=\"verbose expandable\"><span class=\"error2\">&lt;--- %s <span class=\"marker\">[+]</span></span><div class=\"content\">%s</div></div>\n"
+HTML_EXPANDABLE_INCONCLUSIVE = "<div class=\"verbose expandable\"><span class=\"inconclusive2\">&lt;--- %s <span class=\"marker\">[+]</span></span><div class=\"content\">%s</div></div>\n"
+# escape() and unescape() takes care of &, < and >.
+html_escape_table = {
+    '"': "&quot;",
+    "'": "&apos;"
+}
+html_unescape_table = {v: k for k, v in html_escape_table.items()}
+def html_escape(text):
+    return escape(text, html_escape_table)
+def filter_button(enabled_filters, id, function):
+    enabled = enabled_filters.get(id, False)
+    if not id:
+        id = 'None'
+    return '\n        <label class="checkBtn%s"><input type="checkbox" onclick="%s(this)" id="%s" %s>%s</label>'\
+          % (' disabled' if not enabled else '', function, id, 'checked' if enabled else 'disabled', id)
+def filter_bar(enabled):
+    severity_bar = ''.join([filter_button(enabled, severity, 'toggleSeverity') for severity in ['error', 'warning', 'portability', 'performance', 'style', 'information']]) + '\n        | '
+    classification_bar = ''.join([filter_button(enabled, _class, 'toggleClassification') for _class in ['Mandatory', 'Required', 'Advisory', 'Document', 'Disapplied', 'L1','L2','L3','']]) + '\n        | '
+    if "checked/>" not in severity_bar:
+        severity_bar = ''
+    if "checked/>" not in classification_bar:
+        classification_bar = ''
+    return ''.join([
+     '      <div id="filters">\n'
+    ,severity_bar
+    , classification_bar
+    ,''.join([filter_button(enabled, tool, 'toggleTool') for tool in ['cppcheck', 'clang-tidy']])
+    ,'\n        | '
+    ,'\n        <label class="severityHeader">File: <input type="search" oninput="filterFile(this.value)"></label>'
+    ,'\n        <label class="severityHeader">Filter: <input type="search" oninput="filterText(this.value)"></label>'
+    ,'\n      </div>\n'])
+def git_blame(errors, path, file, blame_options):
+    last_line= errors[-1]['line']
+    if last_line == 0:
+        return {}
+    first_line = next((error for error in errors if error['line'] > 0))['line']
+    full_path = os.path.join(path, file)
+    path, filename = os.path.split(full_path)
+    if not path:
+        path = None  # make sure this is None
+    cmd_args = ['git', 'blame', '-L %d,%d' % (first_line, last_line)]
+    if '-w' in blame_options:
+        cmd_args.append('-w')
+    if '-M' in blame_options:
+        cmd_args.append('-M')
+    cmd_args = cmd_args + ['--porcelain', '--incremental', '--', filename]
+    try:
+        result = subprocess.check_output(cmd_args, cwd=path)
+        result = result.decode(locale.getpreferredencoding())
+    except:
+        return []
+    if result.startswith('fatal'):
+        return []
+    blame_data = []
+    line_from = 0
+    line_to = 0
+    blame_info = {}
+    for line_str in result.splitlines():
+        field, _, value = line_str.partition(' ')
+        if len(field) == 40:
+            line_nr, count = value.split(' ')[1:]
+            line_from = int(line_nr)
+            line_to = line_from + int(count)
+        elif field.startswith('author'):
+            blame_info[field] = value
+            if field == 'author-time':
+                author_date = date.fromtimestamp(int(blame_info['author-time']))
+                blame_info['author-time'] = author_date.strftime("%d/%m/%Y")
+        elif field == 'filename':
+            blame_data.append([line_from, line_to, blame_info.copy()])
+    return blame_data
+def blame_lookup(blame_data, line):
+    return next((data for start, end, data in blame_data if line >= start and line < end), {})
+def tr_str(td_th, line, id, cwe, severity, classification, guideline, message, timestamp, author, author_mail, date, add_author, tr_class=None, htmlfile=None, message_class=None):
+    ret = ''
+    items = [id, cwe]
+    if severity:
+        items.append(severity)
+    if classification:
+        items.extend([classification, guideline])
+    if htmlfile:
+        if htmlfile.startswith("http://") or htmlfile.startswith("https://"):
+            # GitHub/GitLab style line anchor
+            href = f"{htmlfile.rstrip('#L1')}#L{line}"
+            # Emit **line number with link**
+            ret += f'<{td_th}><a href="{href}" target="_blank" rel="noopener noreferrer">{line}</a></{td_th}>'
+        else:
+            # local HTML annotated
+            href = f"{htmlfile}#line-{line}"
+            # Emit **line number with link**
+            ret += f'<{td_th}><a href="{href}">{line}</a></{td_th}>'
+        # Emit id, cwe, severity, classification, ...
+        for item in items:
+            ret += f'<{td_th}>{item}</{td_th}>'
+    else:
+        items.insert(0,line)
+        for item in items:
+            ret += '<%s>%s</%s>' % (td_th, item, td_th)
+    if message_class:
+        message_attribute = ' class="%s"' % message_class
+    else:
+        message_attribute = ''
+    ret += '<%s%s>%s</%s>' % (td_th, message_attribute, html_escape(message), td_th)
+    if timestamp:
+        ret += '<%s>%s</%s>' % (td_th, timestamp, td_th)
+    for field in  add_author:
+        if field == 'name':
+            ret += '<%s>%s</%s>' % (td_th, html_escape(author), td_th)
+        elif field == 'email':
+            ret += '<%s>%s</%s>' % (td_th, html_escape(author_mail), td_th)
+        elif field == 'date':
+            ret += '<%s>%s</%s>' % (td_th, date, td_th)
+    if tr_class:
+        tr_attributes = ' class="%s"' % tr_class
+    else:
+        tr_attributes = ''
+    return '<tr%s>%s</tr>' % (tr_attributes, ret)
+def to_css_selector(tag):
+    # https://www.w3.org/TR/CSS2/syndata.html#characters
+    # Note: for our usage, we don't consider escaped characters
+    invalid_css_chars = re.compile(r"[^-_a-zA-Z0-9\u00A0-\uFFFF]")
+    invalid_start = re.compile(r"^([0-9]|-[0-9]|--)")
+    # Replace forbidden characters by an hyphen
+    valid_chars = invalid_css_chars.sub("-", tag)
+    # Check that the start of the tag doesn't break the rules
+    start_invalid = invalid_start.match(valid_chars)
+    if start_invalid:
+        # otherwise, append a token to make it valid
+        valid_chars_valid_start = "cpp" + valid_chars
+    else:
+        valid_chars_valid_start = valid_chars
+    return valid_chars_valid_start
+class AnnotateCodeFormatter(HtmlFormatter):
+    errors = []
+    def wrap(self, *args, **kwargs):
+        line_no = 1
+        for i, t in HtmlFormatter.wrap(self, *args, **kwargs):
+            # 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:
+                        try:
+                            if error['inconclusive'] == 'true':
+                                # only print verbose msg if it really differs
+                                # from actual message
+                                if error.get('verbose') and (error['verbose'] != error['msg']):
+                                    index = t.rfind('\n')
+                                    t = t[:index] + HTML_EXPANDABLE_INCONCLUSIVE % (error['msg'], html_escape(error['verbose'].replace("\\012", '\n'))) + t[index + 1:]
+                                else:
+                                    t = t.replace('\n', HTML_INCONCLUSIVE % error['msg'])
+                        except KeyError:
+                            if error.get('verbose') and (error['verbose'] != error['msg']):
+                                index = t.rfind('\n')
+                                t = t[:index] + HTML_EXPANDABLE_ERROR % (error['msg'], html_escape(error['verbose'].replace("\\012", '\n'))) + t[index + 1:]
+                            else:
+                                t = t.replace('\n', HTML_ERROR % error['msg'])
+                line_no = line_no + 1
+            yield i, t
+class CppCheckHandler(XmlContentHandler):
+    """Parses the cppcheck xml file and produces a list of all its errors."""
+    def __init__(self):
+        XmlContentHandler.__init__(self)
+        self.errors = []
+        self.version = '1'
+        self.versionCppcheck = ''
+        self.timestamp = ''
+        self.report_type = False
+    def startElement(self, name, attributes):
+        if name == 'results':
+            self.version = attributes.get('version', self.version)
+        if self.version == '1':
+            self.handleVersion1(name, attributes)
+        else:
+            self.handleVersion2(name, attributes)
+    def handleVersion1(self, name, attributes):
+        if name != 'error':
+            return
+        att_class = attributes.get('classification', '')
+        att_guide = attributes.get('guideline', '')
+        if att_class and not self.report_type:
+            self.report_type = True
+        self.errors.append({
+            'file': attributes.get('file', ''),
+            'line': int(attributes.get('line', 0)),
+            'locations': [{
+                'file': attributes.get('file', ''),
+                'line': int(attributes.get('line', 0)),
+            }],
+            'id': attributes['id'],
+            'severity': attributes['severity'],
+            'classification': att_class,
+            'guideline': att_guide,
+            'timestamp': self.timestamp,
+            'msg': attributes['msg']
+        })
+    def handleVersion2(self, name, attributes):
+        if name == 'cppcheck':
+            self.versionCppcheck = attributes['version']
+        if name == 'error':
+            att_class = attributes.get('classification', '')
+            att_guide = attributes.get('guideline', '')
+            if att_class and not self.report_type:
+                self.report_type = True
+            error = {
+                'locations': [],
+                'file': '',
+                'line': 0,
+                'id': attributes['id'],
+                'classification': att_class,
+                'severity': attributes['severity'],
+                'guideline': att_guide,
+                'timestamp': self.timestamp,
+                'msg': attributes['msg'],
+                'verbose': attributes.get('verbose')
+            }
+            if 'inconclusive' in attributes:
+                error['inconclusive'] = attributes['inconclusive']
+            if 'cwe' in attributes:
+                error['cwe'] = attributes['cwe']
+            self.errors.append(error)
+        elif name == 'location':
+            assert self.errors
+            error = self.errors[-1]
+            locations = error['locations']
+            file = attributes['file']
+            line = int(attributes['line'])
+            if not locations:
+                error['file'] = file
+                error['line'] = line
+            locations.append({
+                'file': file,
+                'line': line,
+                'info': attributes.get('info')
+            })
+def main() -> None:
+    # Configure all the options this little utility is using.
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--title', dest='title',
+                        help='The title of the project.',
+                        default='[project name]')
+    parser.add_argument('--file', dest='file', action="append",
+                        help='The cppcheck xml output file to read defects '
+                             'from. You can combine results from several '
+                             'xml reports i.e. "--file file1.xml --file file2.xml ..". '
+                             'Default is reading from stdin.')
+    parser.add_argument('--checkers-report-file', dest='checkers_report',
+                      help='The cppcheck checkers report file as produced '
+                           'with the "--checkers-report" option of cppcheck.')
+    parser.add_argument('--report-dir', dest='report_dir',
+                         help='The directory where the HTML report content is '
+                              'written.')
+    parser.add_argument('--source-dir', dest='source_dir',
+                         help='Base directory where source code files can be '
+                              'found, or a URL to a remote GitHub/GitLab '
+                              'repository including a branch, e.g. '
+                              '--source-dir=https://github.com/<username>/<repo>/blob/<branch>/')
+    parser.add_argument('--add-author-information', dest='add_author_information',
+                        help='Blame information to include. '
+                             'Adds specified author information. '
+                             'Specify as comma-separated list of either "name", "email", "date" or "n","e","d". '
+                             'Default: "n,e,d"')
+    parser.add_argument('--source-encoding', dest='source_encoding',
+                      help='Encoding of source code.', default='utf-8')
+    parser.add_argument('--blame-options', dest='blame_options',
+                        help='[-w, -M] blame options which you can use to get author and author mail  '
+                             '-w --> not including white spaces and returns original author of the line  '
+                             '-M --> not including moving of lines and returns original author of the line')
+    # Parse options and make sure that we have an output directory set.
+    options = parser.parse_args()
+    try:
+        sys.argv[1]
+    except IndexError:  # no arguments give, print --help
+        parser.print_help()
+        sys.exit(0)
+    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
+    is_remote = False
+    if source_dir.startswith("http://") or source_dir.startswith("https://"):
+        is_remote = True
+    add_author_information = []
+    if options.add_author_information:
+        fields = [x.strip() for x in options.add_author_information.split(',')]
+        for x in fields:
+            if x.lower() in ['n', 'name']:
+                add_author_information.append('name')
+            elif x.lower() in ['e', 'email']:
+                add_author_information.append('email')
+            elif x.lower() in ['d', 'date']:
+                add_author_information.append('date')
+            else:
+                print('Unrecognized value "%s" for author information, using default (name, email, date)' % x)
+                add_author_information = ['name', 'email', 'date']
+                break
+    blame_options = ''
+    if options.blame_options:
+        blame_options = options.blame_options
+        add_author_information = add_author_information or ['name', 'email', 'date']
+    # Parse the xml from all files defined in file argument
+    # or from stdin. If no input is provided, stdin is used
+    # Produce a simple list of errors.
+    print('Parsing xml report.')
+    try:
+        contentHandler = CppCheckHandler()
+        for fname in options.file or [sys.stdin]:
+            if options.file is not None:
+                t = os.path.getmtime(fname)
+            else:
+                t = time.time()
+            t_s = time.ctime(t)
+            if t_s is not None:
+                contentHandler.timestamp = t_s
+            xml_parse(fname, contentHandler)
+    except (XmlParseException, ValueError) as msg:
+        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:
+            if is_remote:
+                # Construct remote URL for GitHub/GitLab
+                # tr_str() will use the actual line number, so we can just start with line 1
+                remote_url = source_dir.rstrip('/') + '/' + filename + '#L1'
+                files[filename] = {'errors': [], 'htmlfile': remote_url}
+            else:
+                files[filename] = {'errors': [], 'htmlfile': str(file_no) + '.html'}
+                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.makedirs(options.report_dir)
+    # Generate a HTML file with syntax highlighted source code for each
+    # file that contains one or more errors.
+    print('Processing errors')
+    decode_errors = []
+    for filename, data in sorted(files.items()):
+        htmlfile = data['htmlfile']
+        errors = []
+        for error in data['errors']:
+            for location in error['locations']:
+                if filename == location['file']:
+                    newError = dict(error)
+                    del newError['locations']
+                    newError['line'] = location['line']
+                    if location.get('info'):
+                        newError['msg'] = location['info']
+                        newError['severity'] = 'information'
+                        newError['classification'] = ''
+                        newError['guideline'] = ''
+                        del newError['verbose']
+                    errors.append(newError)
+        lines = []
+        for error in errors:
+            lines.append(error['line'])
+        if filename == '':
+            continue
+        if is_remote:
+            # Remote source: do NOT generate local annotated HTML files.
+            # The index will still point directly to GitHub/GitLab URLs.
+            continue
+        source_filename = os.path.join(source_dir, filename)
+        try:
+            with io.open(source_filename, 'r', encoding=options.source_encoding) as input_file:
+                content = input_file.read()
+        except IOError:
+            if error['id'] != 'unmatchedSuppression':
+                sys.stderr.write("ERROR: Source file '%s' not found.\n" %
+                                 source_filename)
+            continue
+        except UnicodeDecodeError:
+            sys.stderr.write("WARNING: Unicode decode error in '%s'.\n" %
+                             source_filename)
+            decode_errors.append(source_filename[2:])  # "[2:]" gets rid of "./" at beginning
+            continue
+        htmlFormatter = AnnotateCodeFormatter(linenos=True,
+                                              style='colorful',
+                                              hl_lines=lines,
+                                              lineanchors='line',
+                                              encoding=options.source_encoding)
+        htmlFormatter.errors = errors
+        with io.open(os.path.join(options.report_dir, htmlfile), 'w', encoding='utf-8') as output_file:
+            output_file.write(HTML_HEAD %
+                              (options.title,
+                               htmlFormatter.get_style_defs('.highlight'),
+                               options.title,
+                               ': ' + filename))
+            output_file.write(HTML_HEAD_END)
+            output_file.write(HTML_MENU % (filename.split('/')[-1]))
+            for error in sorted(errors, key=lambda k: k['line']):
+                output_file.write("<a href=\"%s#line-%d\"> %s %s</a>" % (data['htmlfile'], error['line'], error['id'], error['line']))
+            output_file.write(HTML_MENU_END)
+            try:
+                lexer = guess_lexer_for_filename(source_filename, '', stripnl=False)
+            except ClassNotFound:
+                try:
+                    lexer = guess_lexer(content, stripnl=False)
+                except ClassNotFound:
+                    sys.stderr.write("ERROR: Couldn't determine lexer for the file' " + source_filename + " '. Won't be able to syntax highlight this file.")
+                    output_file.write("\n <tr><td colspan=\"6\"> Could not generate content because pygments failed to determine the code type.</td></tr>")
+                    output_file.write("\n <tr><td colspan=\"6\"> Sorry about this.</td></tr>")
+                    continue
+            if options.source_encoding:
+                lexer.encoding = options.source_encoding
+            output_file.write(
+                highlight(content, lexer, htmlFormatter).decode(
+                    options.source_encoding))
+            output_file.write(HTML_FOOTER % contentHandler.versionCppcheck)
+        print('  ' + filename)
+    # Generate a master index.html file that will contain a list of
+    # all the errors created.
+    print('Creating index.html')
+    with io.open(os.path.join(options.report_dir, 'index.html'),
+                 'w') as output_file:
+        stats_count = 0
+        stats = []
+        filter_enabled = {}
+        for filename, data in sorted(files.items()):
+            for error in data['errors']:
+                stats.append(error['id'])  # get the stats
+                if contentHandler.report_type:
+                    filter_enabled[error['severity']] = False
+                    filter_enabled[error['classification']] = True
+                else:
+                    filter_enabled[error['severity']] = True
+                    filter_enabled[error['classification']] = False
+                filter_enabled['clang-tidy' if error['id'].startswith('clang-tidy-') else 'cppcheck'] = True
+                stats_count += 1
+        counter = Counter(stats)
+        stat_html = []
+        # the following lines sort the stat primary by value (occurrences),
+        # but if two IDs occur equally often, then we sort them alphabetically by warning ID
+        try:
+            cnt_max = counter.most_common()[0][1]
+        except IndexError:
+            cnt_max = 0
+        try:
+            cnt_min = counter.most_common()[-1][1]
+        except IndexError:
+            cnt_min = 0
+        stat_fmt = "\n            <tr><td><input type=\"checkbox\" class=\"idToggle\" onclick=\"toggleDisplay(this)\" id=\"{}\" name=\"{}\" checked></td><td>{}</td><td>{}</td></tr>"
+        for occurrences in reversed(range(cnt_min, cnt_max + 1)):
+            for _id in [k for k, v in sorted(counter.items()) if v == occurrences]:
+                stat_html.append(stat_fmt.format(
+                    to_css_selector(_id),
+                    to_css_selector(_id),
+                    dict(counter.most_common())[_id],
+                    _id
+                ))
+        output_file.write(HTML_HEAD % (options.title, '', options.title, ''))
+        output_file.write(filter_bar(filter_enabled))
+        output_file.write(HTML_HEAD_END)
+        output_file.write(HTML_MENU.replace('id="menu"', 'id="menu_index"', 1).replace("Defects:", "Defect summary", 1) % (''))
+        output_file.write('\n       <label><input type="checkbox" class=\"idToggle\" onclick="toggleAll()" checked> Toggle all</label>')
+        output_file.write('\n       <table>')
+        output_file.write('\n           <tr><th>Show</th><th>#</th><th>Defect ID</th></tr>')
+        output_file.write(''.join(stat_html))
+        output_file.write('\n           <tr><td></td><td>' + str(stats_count) + '</td><td>total</td></tr>')
+        output_file.write('\n       </table>')
+        output_file.write('\n       <p><a href="stats.html">Statistics</a></p>')
+        if options.checkers_report:
+            output_file.write('\n       <p><a href="checkers.html">Checkers</a></p>')
+        output_file.write(HTML_MENU_END.replace("content", "content_index", 1))
+        output_file.write('\n       <table class=\"summaryTable\">')
+        if contentHandler.report_type:
+            output_file.write(
+                '\n       %s' %
+                tr_str('th', 'Line', 'Id', 'CWE', '', 'Classification', 'Guideline', 'Message', 'Timestamp',
+                       'Author', 'Author mail', 'Date (DD/MM/YYYY)', add_author=add_author_information))
+        else:
+            output_file.write(
+                '\n       %s' %
+                tr_str('th', 'Line', 'Id', 'CWE', 'Severity', '', '', 'Message', 'Timestamp', 'Author', 'Author mail', 'Date (DD/MM/YYYY)', add_author=add_author_information))
+        for filename, data in sorted(files.items()):
+            file_error = filename in decode_errors or filename.endswith('*')
+            is_file = filename != '' and not file_error
+            row_content = filename if file_error else "<a href=\"%s\">%s</a>" % (data['htmlfile'], filename)
+            htmlfile = data.get('htmlfile') if is_file else None
+            output_file.write("\n      <tbody class=\"fileEntry\">")
+            output_file.write("\n       <tr><td colspan=\"6\">%s</td></tr>" % row_content)
+            if filename in decode_errors:
+                output_file.write("\n       <tr><td colspan=\"6\">Could not generated due to UnicodeDecodeError</td></tr>")
+            sorted_errors = sorted(data['errors'], key=lambda k: k['line'])
+            blame_data = git_blame(sorted_errors, source_dir, filename, blame_options) if add_author_information else []
+            for error in sorted_errors:
+                git_blame_dict = blame_lookup(blame_data, error['line'])
+                message_class = None
+                try:
+                    if error['inconclusive'] == 'true':
+                        message_class = 'inconclusive'
+                        error['severity'] += ", inconcl."
+                except KeyError:
+                    pass
+                cwe_url = ""
+                try:
+                    if error['cwe']:
+                        cwe_url = "<a href=\"https://cwe.mitre.org/data/definitions/" + error['cwe'] + ".html\">" + error['cwe'] + "</a>"
+                except KeyError:
+                    pass
+                if error['severity'] in ['error', 'warning']:
+                    message_class = error['severity']
+                line = error["line"] if is_file else ""
+                _severity = error.get('severity', '')
+                _classification = error.get('classification', '')
+                _guideline = error.get('guideline', '')
+                if contentHandler.report_type:
+                    _severity = ''
+                    if not _classification:
+                        _classification = 'None'
+                        _guideline = 'None'
+                output_file.write(
+                    '\n         %s' %
+                    tr_str('td', line, error["id"], cwe_url, _severity, _classification, _guideline, error["msg"], error["timestamp"],
+                           git_blame_dict.get('author', 'Unknown'), git_blame_dict.get('author-mail', '---'),
+                           git_blame_dict.get('author-time', '---'),
+                           tr_class=to_css_selector(error["id"]) + ' sev_' + _severity  +' class_' + _classification + ' issue',
+                           message_class=message_class,
+                           add_author=add_author_information,
+                           htmlfile=htmlfile))
+        output_file.write("\n      </tbody>")
+        output_file.write('\n       </table>')
+        output_file.write(HTML_FOOTER % contentHandler.versionCppcheck)
+    if decode_errors:
+        sys.stderr.write("\nGenerating html failed for the following files: " + ' '.join(decode_errors))
+        sys.stderr.write("\nConsider changing source-encoding (for example: \"htmlreport ... --source-encoding=\"iso8859-1\"\"\n")
+    print('Creating style.css file')
+    with io.open(os.path.join(options.report_dir, 'style.css'), 'w') as css_file:
+        css_file.write(STYLE_FILE)
+    print("Creating stats.html (statistics)\n")
+    stats_countlist = {}
+    for filename, data in sorted(files.items()):
+        if filename == '':
+            continue
+        stats_tmplist = []
+        for error in sorted(data['errors'], key=lambda k: k['line']):
+            stats_tmplist.append(error['severity'])
+        stats_countlist[filename] = dict(Counter(stats_tmplist))
+    # get top ten for each severity
+    SEVERITIES = "error", "warning", "portability", "performance", "style", "unusedFunction", "information", "missingInclude", "internal"
+    with io.open(os.path.join(options.report_dir, 'stats.html'), 'w') as stats_file:
+        stats_file.write(HTML_HEAD % (options.title, '', options.title, ': Statistics'))
+        stats_file.write(HTML_HEAD_END)
+        stats_file.write(HTML_MENU.replace('id="menu"', 'id="menu_index"', 1).replace("Defects:", "Back to summary", 1) % (''))
+        stats_file.write(HTML_MENU_END.replace("content", "content_index", 1))
+        for sev in SEVERITIES:
+            _sum = 0
+            stats_templist = {}
+            # if the we have an style warning but we are checking for
+            # portability, we have to skip it to prevent KeyError
+            try:
+                for filename in stats_countlist:
+                    try:  # also bail out if we have a file with no sev-results
+                        _sum += stats_countlist[filename][sev]
+                        stats_templist[filename] = int(stats_countlist[filename][sev])  # file : amount,
+                    except KeyError:
+                        continue
+                # don't print "0 style" etc, if no style warnings were found
+                if _sum == 0:
+                    continue
+            except KeyError:
+                continue
+            stats_file.write("<p><span class=\"statHeader\">Top 10 files for " + sev + " severity, total findings: " + str(_sum) + "</span><br>\n")
+            # sort, so that the file with the most severities per type is first
+            stats_list_sorted = sorted(stats_templist.items(), key=operator.itemgetter(1, 0), reverse=True)
+            it = 0
+            LENGTH = 0
+            for i in stats_list_sorted:  # printing loop
+                # for aesthetics: if it's the first iteration of the loop, get
+                # the max length of the number string
+                if it == 0:
+                    LENGTH = len(str(i[1]))  # <- length of longest number, now get the difference and try to  make other numbers align to it
+                stats_file.write("&#160;" * 3 + str(i[1]) + "&#160;" * (1 + LENGTH - len(str(i[1]))) + "<a href=\"" + files[i[0]]['htmlfile'] + "\">  " + i[0] + "</a><br>\n")
+                it += 1
+                if it == 10:  # print only the top 10
+                    break
+            stats_file.write("</p>\n")
+        stats_file.write(HTML_FOOTER % contentHandler.versionCppcheck)
+    if options.checkers_report:
+        print("Creating checkers.html (checkers report)\n")
+        with io.open(os.path.join(options.report_dir, 'checkers.html'), 'w') as checkers_file:
+            checkers_file.write(HTML_HEAD % (options.title, '', options.title, ': Checkers'))
+            checkers_file.write(HTML_HEAD_END)
+            checkers_file.write(HTML_MENU.replace('id="menu"', 'id="menu_index"', 1).replace("Defects:", "Back to summary", 1) % (''))
+            checkers_file.write(HTML_MENU_END.replace("content", "content_index", 1))
+            with io.open(options.checkers_report, 'r', encoding=options.source_encoding) as checkers_report:
+                content = checkers_report.read()
+                checkers_file.write("<pre>\n")
+                checkers_file.write(html_escape(content))
+                checkers_file.write("</pre>\n")
+            checkers_file.write(HTML_FOOTER % contentHandler.versionCppcheck)
+    print("\nOpen '" + options.report_dir + "/index.html' to see the results.")
+if __name__ == "__main__":
+    main()