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
|
#!/usr/bin/env python3
# DESCRIPTION: Verilator: Primitive C++ style checker
#
# Copyright 2024 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU
# Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0.
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
import vltest_bootstrap
test.scenarios('dist')
root = ".."
def get_source_files(root):
git_files = test.run_capture("cd " + root + " && git ls-files")
if test.verbose:
print("MF " + git_files)
files = {}
for filename in git_files.split():
if filename == '':
continue
files[filename] = True
return files
def check_pattern(filename, contents, pattern, not_pattern, message):
lineno = 0
buffer = "\n"
for line in contents.splitlines():
lineno += 1
if line != "":
# Don't do whole file at once - see issue #4085
# Build a buffer until a newline so we check a block at a time.
buffer += line + "\n"
continue
if re.search(r"\n" + pattern, buffer):
if not not_pattern or not re.search(not_pattern, buffer):
test.error(filename + ":" + str(lineno) + ": " + message)
buffer = "\n"
if not os.path.exists(root + "/.git"):
test.skip("Not in a git repository")
files = get_source_files(root)
for filename in sorted(files.keys()):
filename = os.path.join(root, filename)
if not os.path.exists(filename): # git file might be deleted but not yet staged
continue
if not re.search(r'\.(h|c|cpp)(\.in)?$', filename):
continue
if '/gtkwave/' in filename:
continue
contents = test.file_contents(filename) + "\n\n"
check_pattern(filename, contents, r"[^\']*virtual[^{};\n]+override", None,
"'virtual' keyword is redundant on 'override' method")
check_pattern(filename, contents,
r' \s*(\w+ )*\s*(inline) [^;]+?\([^;]*?\)[^;]+?(?:{|:|=\s*default)', None,
"'inline' keyword is redundant on method definitions inside classes")
check_pattern(
filename, contents, r'inline \S+ [^;:(]+::[^;:(]+\([^;]*\)[^;]+{', r'template',
"Use 'inline' only on declaration inside classes"
" (except for template specializations)")
if re.search(r'\.(c|cpp)', filename):
check_pattern(filename, contents, r'(\w+\s+)*(inline)', None,
"'inline' keyword is on functions defined in .cpp files")
test.passes()
|