Retro68/gcc/contrib/check_GNU_style.sh

125 lines
3.1 KiB
Bash
Raw Normal View History

2012-03-27 23:13:14 +00:00
#!/bin/sh
# Checks some of the GNU style formatting rules in a set of patches.
2014-09-21 17:33:12 +00:00
# Copyright (C) 2010, 2012 Free Software Foundation, Inc.
2012-03-27 23:13:14 +00:00
# Contributed by Sebastian Pop <sebastian.pop@amd.com>
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
usage() {
cat <<EOF
check_GNU_style.sh [patch]...
Checks the patches for some of the GNU style formatting problems.
2015-08-28 15:33:40 +00:00
When FILE is -, read standard input.
2012-03-27 23:13:14 +00:00
Please note that these checks are not always accurate, and
complete. The reference documentation of the GNU Coding Standards
can be found here: http://www.gnu.org/prep/standards_toc.html
and there are also some additional coding conventions for GCC:
http://gcc.gnu.org/codingconventions.html
EOF
exit 1
}
test $# -eq 0 && usage
2015-08-28 15:33:40 +00:00
inp=check_GNU_style.inp
2012-03-27 23:13:14 +00:00
tmp=check_GNU_style.tmp
2014-09-21 17:33:12 +00:00
# Remove $tmp on exit and various signals.
2015-08-28 15:33:40 +00:00
trap "rm -f $inp $tmp" 0
trap "rm -f $inp $tmp ; exit 1" 1 2 3 5 9 13 15
grep -nH '^+' $* \
| grep -v ':+++' \
> $inp
2014-09-21 17:33:12 +00:00
2012-03-27 23:13:14 +00:00
# Grep
g (){
msg="$1"
arg="$2"
2015-08-28 15:33:40 +00:00
cat $inp \
2012-03-27 23:13:14 +00:00
| egrep --color=always -- "$arg" \
> $tmp && printf "\n$msg\n"
cat $tmp
}
# And Grep
ag (){
msg="$1"
arg1="$2"
arg2="$3"
2015-08-28 15:33:40 +00:00
cat $inp \
2012-03-27 23:13:14 +00:00
| egrep --color=always -- "$arg1" \
| egrep --color=always -- "$arg2" \
> $tmp && printf "\n$msg\n"
cat $tmp
}
# reVerse Grep
vg (){
msg="$1"
varg="$2"
arg="$3"
2015-08-28 15:33:40 +00:00
cat $inp \
2012-03-27 23:13:14 +00:00
| egrep -v -- "$varg" \
| egrep --color=always -- "$arg" \
> $tmp && printf "\n$msg\n"
cat $tmp
}
col (){
msg="$1"
2015-08-28 15:33:40 +00:00
cat $inp \
| awk -F':\\+' '{ if (length($2) > 80) print $0}' \
2012-03-27 23:13:14 +00:00
> $tmp
if [ -s $tmp ]; then
printf "\n$msg\n"
cat $tmp
fi
}
2015-08-28 15:33:40 +00:00
col 'Lines should not exceed 80 characters.'
g 'Blocks of 8 spaces should be replaced with tabs.' \
' {8}'
2012-03-27 23:13:14 +00:00
g 'Trailing whitespace.' \
2015-08-28 15:33:40 +00:00
'[[:space:]]$'
2012-03-27 23:13:14 +00:00
g 'Space before dot.' \
2015-08-28 15:33:40 +00:00
'[[:alnum:]][[:blank:]]+\.'
2012-03-27 23:13:14 +00:00
g 'Dot, space, space, new sentence.' \
2015-08-28 15:33:40 +00:00
'[[:alnum:]]\.([[:blank:]]|[[:blank:]]{3,})[A-Z0-9]'
2012-03-27 23:13:14 +00:00
g 'Dot, space, space, end of comment.' \
2015-08-28 15:33:40 +00:00
'[[:alnum:]]\.([[:blank:]]{0,1}|[[:blank:]]{3,})\*/'
2012-03-27 23:13:14 +00:00
g 'Sentences should end with a dot. Dot, space, space, end of the comment.' \
2015-08-28 15:33:40 +00:00
'[[:alnum:]][[:blank:]]*\*/'
2012-03-27 23:13:14 +00:00
vg 'There should be exactly one space between function name and parentheses.' \
2015-08-28 15:33:40 +00:00
'\#define' '[[:alnum:]]([[:blank:]]{2,})?\('
2012-03-27 23:13:14 +00:00
g 'There should be no space before closing parentheses.' \
2015-08-28 15:33:40 +00:00
'[[:graph:]][[:blank:]]+\)'
2012-03-27 23:13:14 +00:00
ag 'Braces should be on a separate line.' \
2015-08-28 15:33:40 +00:00
'\{' 'if[[:blank:]]\(|while[[:blank:]]\(|switch[[:blank:]]\('
2012-03-27 23:13:14 +00:00