2016-08-28 17:00:44 +00:00
|
|
|
#!/bin/bash
|
2017-09-10 10:24:33 +00:00
|
|
|
#
|
2016-08-28 17:00:44 +00:00
|
|
|
# Script to check include/test code for common pybind11 code style errors.
|
2017-09-10 10:24:33 +00:00
|
|
|
#
|
2016-09-06 04:02:29 +00:00
|
|
|
# This script currently checks for
|
|
|
|
#
|
2020-07-20 19:07:22 +00:00
|
|
|
# 1. missing space between keyword and parenthesis, e.g.: for(, if(, while(
|
|
|
|
# 2. Missing space between right parenthesis and brace, e.g. 'for (...){'
|
|
|
|
# 3. opening brace on its own line. It should always be on the same line as the
|
2017-11-02 01:08:06 +00:00
|
|
|
# if/while/for/do statement.
|
2017-09-10 10:24:33 +00:00
|
|
|
#
|
2020-07-20 19:07:22 +00:00
|
|
|
# Invoke as: tools/check-style.sh <filenames>
|
2016-08-28 17:00:44 +00:00
|
|
|
#
|
|
|
|
|
2017-09-10 10:24:33 +00:00
|
|
|
check_style_errors=0
|
2016-08-28 18:53:04 +00:00
|
|
|
IFS=$'\n'
|
2016-09-06 04:02:29 +00:00
|
|
|
|
2016-08-28 18:53:04 +00:00
|
|
|
|
2021-07-14 20:52:13 +00:00
|
|
|
found="$(grep '\<\(if\|for\|while\|catch\)(\|){' "$@" -rn --color=always)"
|
2017-09-10 10:24:33 +00:00
|
|
|
if [ -n "$found" ]; then
|
|
|
|
echo -e '\033[31;01mError: found the following coding style problems:\033[0m'
|
|
|
|
check_style_errors=1
|
2021-07-14 20:52:13 +00:00
|
|
|
echo "${found//^/ /}"
|
2017-09-10 10:24:33 +00:00
|
|
|
fi
|
2016-12-12 23:17:29 +00:00
|
|
|
|
2017-09-10 10:24:33 +00:00
|
|
|
found="$(awk '
|
|
|
|
function prefix(filename, lineno) {
|
|
|
|
return " \033[35m" filename "\033[36m:\033[32m" lineno "\033[36m:\033[0m"
|
|
|
|
}
|
|
|
|
function mark(pattern, string) { sub(pattern, "\033[01;31m&\033[0m", string); return string }
|
|
|
|
last && /^\s*{/ {
|
|
|
|
print prefix(FILENAME, FNR-1) mark("\\)\\s*$", last)
|
|
|
|
print prefix(FILENAME, FNR) mark("^\\s*{", $0)
|
|
|
|
last=""
|
|
|
|
}
|
|
|
|
{ last = /(if|for|while|catch|switch)\s*\(.*\)\s*$/ ? $0 : "" }
|
2021-07-14 20:52:13 +00:00
|
|
|
' "$(find include -type f)" "$@")"
|
2017-09-10 10:24:33 +00:00
|
|
|
if [ -n "$found" ]; then
|
|
|
|
check_style_errors=1
|
|
|
|
echo -e '\033[31;01mError: braces should occur on the same line as the if/while/.. statement. Found issues in the following files:\033[0m'
|
|
|
|
echo "$found"
|
|
|
|
fi
|
2016-12-12 23:17:29 +00:00
|
|
|
|
2017-09-10 10:24:33 +00:00
|
|
|
exit $check_style_errors
|