111986Sandreas.sandberg@arm.com#!/bin/bash 212391Sjason@lowepower.com# 311986Sandreas.sandberg@arm.com# Script to check include/test code for common pybind11 code style errors. 412391Sjason@lowepower.com# 511986Sandreas.sandberg@arm.com# This script currently checks for 611986Sandreas.sandberg@arm.com# 711986Sandreas.sandberg@arm.com# 1. use of tabs instead of spaces 811986Sandreas.sandberg@arm.com# 2. MSDOS-style CRLF endings 911986Sandreas.sandberg@arm.com# 3. trailing spaces 1011986Sandreas.sandberg@arm.com# 4. missing space between keyword and parenthesis, e.g.: for(, if(, while( 1111986Sandreas.sandberg@arm.com# 5. Missing space between right parenthesis and brace, e.g. 'for (...){' 1211986Sandreas.sandberg@arm.com# 6. opening brace on its own line. It should always be on the same line as the 1314299Sbbruce@ucdavis.edu# if/while/for/do statement. 1412391Sjason@lowepower.com# 1511986Sandreas.sandberg@arm.com# Invoke as: tools/check-style.sh 1611986Sandreas.sandberg@arm.com# 1711986Sandreas.sandberg@arm.com 1812391Sjason@lowepower.comcheck_style_errors=0 1911986Sandreas.sandberg@arm.comIFS=$'\n' 2011986Sandreas.sandberg@arm.com 2112391Sjason@lowepower.comfound="$( GREP_COLORS='mt=41' GREP_COLOR='41' grep $'\t' include tests/*.{cpp,py,h} docs/*.rst -rn --color=always )" 2212391Sjason@lowepower.comif [ -n "$found" ]; then 2312391Sjason@lowepower.com # The mt=41 sets a red background for matched tabs: 2412391Sjason@lowepower.com echo -e '\033[31;01mError: found tab characters in the following files:\033[0m' 2512391Sjason@lowepower.com check_style_errors=1 2612391Sjason@lowepower.com echo "$found" | sed -e 's/^/ /' 2712391Sjason@lowepower.comfi 2811986Sandreas.sandberg@arm.com 2911986Sandreas.sandberg@arm.com 3012391Sjason@lowepower.comfound="$( grep -IUlr $'\r' include tests/*.{cpp,py,h} docs/*.rst --color=always )" 3112391Sjason@lowepower.comif [ -n "$found" ]; then 3212391Sjason@lowepower.com echo -e '\033[31;01mError: found CRLF characters in the following files:\033[0m' 3312391Sjason@lowepower.com check_style_errors=1 3412391Sjason@lowepower.com echo "$found" | sed -e 's/^/ /' 3512391Sjason@lowepower.comfi 3611986Sandreas.sandberg@arm.com 3712391Sjason@lowepower.comfound="$(GREP_COLORS='mt=41' GREP_COLOR='41' grep '[[:blank:]]\+$' include tests/*.{cpp,py,h} docs/*.rst -rn --color=always )" 3812391Sjason@lowepower.comif [ -n "$found" ]; then 3912391Sjason@lowepower.com # The mt=41 sets a red background for matched trailing spaces 4012391Sjason@lowepower.com echo -e '\033[31;01mError: found trailing spaces in the following files:\033[0m' 4112391Sjason@lowepower.com check_style_errors=1 4212391Sjason@lowepower.com echo "$found" | sed -e 's/^/ /' 4312391Sjason@lowepower.comfi 4411986Sandreas.sandberg@arm.com 4512391Sjason@lowepower.comfound="$(grep '\<\(if\|for\|while\|catch\)(\|){' include tests/*.{cpp,h} -rn --color=always)" 4612391Sjason@lowepower.comif [ -n "$found" ]; then 4712391Sjason@lowepower.com echo -e '\033[31;01mError: found the following coding style problems:\033[0m' 4812391Sjason@lowepower.com check_style_errors=1 4912391Sjason@lowepower.com echo "$found" | sed -e 's/^/ /' 5012391Sjason@lowepower.comfi 5111986Sandreas.sandberg@arm.com 5212391Sjason@lowepower.comfound="$(awk ' 5312391Sjason@lowepower.comfunction prefix(filename, lineno) { 5412391Sjason@lowepower.com return " \033[35m" filename "\033[36m:\033[32m" lineno "\033[36m:\033[0m" 5512391Sjason@lowepower.com} 5612391Sjason@lowepower.comfunction mark(pattern, string) { sub(pattern, "\033[01;31m&\033[0m", string); return string } 5712391Sjason@lowepower.comlast && /^\s*{/ { 5812391Sjason@lowepower.com print prefix(FILENAME, FNR-1) mark("\\)\\s*$", last) 5912391Sjason@lowepower.com print prefix(FILENAME, FNR) mark("^\\s*{", $0) 6012391Sjason@lowepower.com last="" 6112391Sjason@lowepower.com} 6212391Sjason@lowepower.com{ last = /(if|for|while|catch|switch)\s*\(.*\)\s*$/ ? $0 : "" } 6312391Sjason@lowepower.com' $(find include -type f) tests/*.{cpp,h} docs/*.rst)" 6412391Sjason@lowepower.comif [ -n "$found" ]; then 6512391Sjason@lowepower.com check_style_errors=1 6612391Sjason@lowepower.com 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' 6712391Sjason@lowepower.com echo "$found" 6812391Sjason@lowepower.comfi 6911986Sandreas.sandberg@arm.com 7012391Sjason@lowepower.comexit $check_style_errors 71