Fix a bunch of platform name and other typos.
[libav.git] / tools / patcheck
CommitLineData
6c2dd77e
MN
1#!/bin/sh
2
09d7da86
RC
3# if no argument provided, write stdin to a file and re-run the script
4if [ $# = 0 ]; then
5 cat > patcheck.stdout
6 $0 patcheck.stdout
7 rm -f patcheck.stdout
8 exit
9fi
10
ff3be572
B
11GREP=grep
12EGREP=egrep
6c2dd77e
MN
13TMP=patcheck.tmp
14OPT="-nH"
6252040e 15#FILES=$($GREP '^+++' $* | sed 's/+++ //g')
6c2dd77e
MN
16
17echo patCHeck 1e10.0
18echo This tool is intended to help a human check/review patches it is very far from
19echo being free of false positives and negatives, its output are just hints of what
20echo may or may not be bad. When you use it and it misses something or detects
14622ef0 21echo something wrong, fix it and send a patch to the libav-devel mailing list.
6c2dd77e
MN
22echo License:GPL Autor: Michael Niedermayer
23
24ERE_PRITYP='(unsigned *|)(char|short|long|int|long *int|short *int|void|float|double|(u|)int(8|16|32|64)_t)'
25ERE_TYPES='(const|static|av_cold|inline| *)*('$ERE_PRITYP'|[a-zA-Z][a-zA-Z0-9_]*)[* ]{1,}[a-zA-Z][a-zA-Z0-9_]*'
26ERE_FUNCS="$ERE_TYPES"' *\('
27
28hiegrep(){
29 arg="$1"
30 msg="$2"
31 shift 2
ff3be572 32 $GREP $OPT '^+' $* | $GREP -v ':+++'| $EGREP --color=always -- "$arg"> $TMP && printf "\n$msg\n"
6c2dd77e
MN
33 cat $TMP
34}
35
3d8f9025
MN
36hiegrep2(){
37 arg="$1"
38 varg="$2"
39 msg="$3"
40 shift 3
ff3be572 41 $GREP $OPT '^+' $* | $GREP -v ':+++' | $EGREP -v -- "$varg" | $EGREP --color=always -- "$arg" > $TMP && printf "\n$msg\n"
3d8f9025
MN
42 cat $TMP
43}
44
6c2dd77e 45hiegrep '[[:space:]]$' 'trailing whitespace' $*
6252040e 46hiegrep "$(echo x | tr 'x' '\t')" 'tabs' $*
6c2dd77e
MN
47#hiegrep ':\+$' 'Empty lines' $*
48hiegrep ';;' 'double ;' $*
74892f7a 49hiegrep2 '\b_[a-zA-Z0-9_]{1,}' '__(asm|attribute)([^a-zA-Z0-9]|$)' 'reserved identifer' $*
6c2dd77e
MN
50hiegrep '//[-/<\* ]*$' 'empty comment' $*
51hiegrep '/\*[-<\* ]*\*/' 'empty comment' $*
52hiegrep 'for *\( *'"$ERE_PRITYP"' ' 'not gcc 2.95 compatible' $*
be3e68b2 53hiegrep '(static|inline|const) *\1' 'duplicate word' $*
9e793a24 54hiegrep 'INIT_VLC_USE_STATIC' 'forbidden ancient vlc type' $*
35614edb 55hiegrep '=[-+\*\&] ' 'looks like compound assignment' $*
78db142a 56hiegrep2 '/\*\* *[a-zA-Z0-9].*' '\*/' 'Inconsistently formatted doxygen comment' $*
3ea4d942 57hiegrep '; */\*\*[^<]' 'Misformatted doxygen comment' $*
def5dc12 58hiegrep '//!|/\*!' 'inconsistent doxygen syntax' $*
6c2dd77e 59
3d8f9025 60hiegrep2 '(int|unsigned|static|void)[a-zA-Z0-9 _]*(init|end)[a-zA-Z0-9 _]*\(.*[^;]$' '(av_cold|:\+[^a-zA-Z_])' 'These functions may need av_cold, please review the whole patch for similar functions needing av_cold' $*
6c2dd77e
MN
61
62hiegrep '\+= *1 *;' 'can be simplified to ++' $*
63hiegrep '-= *1 *;' 'can be simplified to --' $*
64hiegrep '((!|=)= *(0|NULL)[^0-9a-z]|[^0-9a-z](0|NULL) *(!|=)=)' 'x==0 / x!=0 can be simplified to !x / x' $*
65
ff3be572 66$EGREP $OPT '^\+ *(const *|)static' $*| $EGREP --color=always '[^=]= *(0|NULL)[^0-9a-zA-Z]'> $TMP && printf '\nuseless 0 init\n'
6c2dd77e
MN
67cat $TMP
68hiegrep '# *ifdef * (HAVE|CONFIG)_' 'ifdefs that should be #if' $*
69
5ea20630 70hiegrep '\b(awnser|cant|dont|wont|usefull|successfull|occured|teh|alot|wether|skiped|heigth|informations|colums|loosy|loosing|seperate|preceed|upto|paket|posible)\b' 'common typos' $*
6c2dd77e
MN
71
72hiegrep 'av_log\( *NULL' 'Missing context in av_log' $*
73hiegrep '[^sn]printf' 'Please use av_log' $*
74hiegrep '\bmalloc' 'Please use av_malloc' $*
75hiegrep '\) *av_malloc' 'useless casts' $*
76hiegrep ':\+ *'"$ERE_PRITYP"' *inline' 'non static inline or strangely ordered inline+static' $*
77hiegrep "$ERE_FUNCS"' *\)' 'missing void' $*
78hiegrep '(sprintf|strcat|strcpy)' 'Possible security issue, make sure this is safe or use snprintf/av_strl*' $*
79hiegrep '/ *(2|4|8|16|32|64|128|256|512|1024|2048|4096|8192|16384|32768|65536)[^0-9]' 'divide by 2^x could use >> maybe' $*
80hiegrep '#(el|)if *(0|1)' 'useless #if' $*
81hiegrep 'if *\( *(0|1) *\)' 'useless if()' $*
82hiegrep '& *[a-zA-Z0-9_]* *\[ *0 *\]' 'useless & [0]' $*
83hiegrep '(\( *[0-9] *(&&|\|\|)|(&&|\|\|) *[0-9] *\))' 'overriding condition' $*
214ee5f5
MN
84hiegrep '(:\+|,|;)( *|static|\*)*'"$ERE_PRITYP"' *\*( |\*)*(src|source|input|in[^a-z])' 'missing const?' $*
85hiegrep '(:\+|,|;)( *|static|\*)*'"$ERE_PRITYP"' *(src|source|input|in)([0-9A-Z_][0-9A-Za-z_]*){1,} *\[' 'missing const (test2)?' $*
70ec53a0 86hiegrep ' *static *'"$ERE_FUNCS"'[^)]*\);' 'static prototype, maybe you should reorder your functions' $*
c4e12a9f 87hiegrep '@file: *[a-zA-Z0-9_]' 'doxy filetag with filename can in the future cause problems when forgotten during a rename' $*
c7d22c5d 88hiegrep '\bassert' 'Please use av_assert0, av_assert1 or av_assert2' $*
6c2dd77e 89
3d8f9025 90hiegrep2 '\.long_name *=' 'NULL_IF_CONFIG_SMAL' 'missing NULL_IF_CONFIG_SMAL' $*
4a0cf686
DV
91hiegrep2 '\.pix_fmts *= *\(' 'const' 'missing const for pix_fmts array' $*
92hiegrep2 '\.sample_fmts *= *\(' 'const' 'missing const for sample_fmts array' $*
93hiegrep2 '\.supported_framerates *= *\(' 'const' 'missing const for supported_framerates array' $*
94hiegrep2 '\.channel_layouts *= *\(' 'const' 'missing const for channel_layouts array' $*
6c2dd77e 95
ff3be572 96#$EGREP $OPT '^\+.*const ' $*| $GREP -v 'static'> $TMP && printf '\nnon static const\n'
6c2dd77e
MN
97#cat $TMP
98
3d8f9025 99hiegrep2 "$ERE_TYPES" '(static|av_|ff_|typedef|:\+[^a-zA-Z_])' 'Non static with no ff_/av_ prefix' $*
6c2dd77e 100
0f485a9c 101hiegrep ':\+[^}#]*else' 'missing } prior to else' $*
54ce8a4c
MN
102hiegrep '(if|while|for)\(' 'missing whitespace between keyword and ( (feel free to ignore)' $*
103hiegrep '(else|do){' 'missing whitespace between keyword and { (feel free to ignore)' $*
104hiegrep '}(else|while)' 'missing whitespace between } and keyword (feel free to ignore)' $*
6c2dd77e
MN
105
106#FIXME this should print the previous statement maybe
107hiegrep ':\+ *{ *$' '{ should be on the same line as the related previous statement' $*
108
109
110rm $TMP
6252040e
DB
111for i in $($GREP -H '^+.*@param' $*| sed 's/^\([^:]*\):.*@param\(\[.*\]\|\) *\([a-zA-Z0-9_]*\) .*$/\1:\3/') ; do
112 doxpar=$(echo $i | sed 's/^.*:\(.*\)$/\1/')
113 file=$(echo $i | sed 's/^\([^:]*\):.*$/\1/')
ff3be572 114 $GREP " *$doxpar *[),]" $file | $GREP -v '@param' >/dev/null || $GREP --color=always "@param *$doxpar" $file >>$TMP
6c2dd77e
MN
115done
116if test -e $TMP ; then
f11c9ee9 117 printf '\nmismatching doxy params\n'
6c2dd77e
MN
118 cat $TMP
119fi
120
ff3be572 121$EGREP -B2 $OPT '^(\+|) *('"$ERE_TYPES"'|# *define)' $* | $EGREP -A2 --color=always '(:|-)\+[^/]*/(\*([^*]|$)|/([^/]|$))' > $TMP && printf "\n Non doxy comments\n"
6c2dd77e
MN
122cat $TMP
123
124rm $TMP
125for i in \
6252040e 126 $($EGREP -H '^\+ *'"$ERE_TYPES" $* |\
ff3be572 127 $GREP -v '(' | $EGREP -v '\Wgoto\W' |\
6c2dd77e 128 xargs -d '\n' -n 1 |\
ff3be572 129 $GREP -o '[* ][* ]*[a-zA-Z][0-9a-zA-Z_]* *[,;=]' |\
6252040e 130 sed 's/.[* ]*\([a-zA-Z][0-9a-zA-Z_]*\) *[,;=]/\1/') \
6c2dd77e 131 ; do
ff3be572
B
132 echo $i | $GREP '^NULL$' && continue
133 $EGREP $i' *(\+|-|\*|/|\||&|%|)=[^=]' $* >/dev/null || echo "possibly never written:"$i >> $TMP
134 $EGREP '(=|\(|return).*'$i'(==|[^=])*$' $* >/dev/null || echo "possibly never read :"$i >> $TMP
135 $EGREP -o $i' *((\+|-|\*|/|\||&|%|)=[^=]|\+\+|--) *(0x|)[0-9]*(;|)' $* |\
136 $EGREP -v $i' *= *(0x|)[0-9]{1,};'>/dev/null || echo "possibly constant :"$i >> $TMP
6c2dd77e
MN
137done
138if test -e $TMP ; then
f11c9ee9 139 printf '\npossibly unused variables\n'
6c2dd77e
MN
140 cat $TMP
141fi
142
ff3be572 143$GREP '^+++ .*Changelog' $* >/dev/null || printf "\nMissing changelog entry (ignore if minor change)\n"
6c2dd77e 144
ff3be572 145cat $* | tr '\n' '@' | $EGREP --color=always -o '(fprintf|av_log|printf)\([^)]*\)[+ ;@]*\1' >$TMP && printf "\nMergeable calls\n"
6c2dd77e
MN
146cat $TMP | tr '@' '\n'
147
ff3be572 148cat $* | tr '\n' '@' | $EGREP --color=always -o '\+ *if *\( *([A-Za-z0-9_]*) *[<>]=? *[0-9]* *\) * \1 *= *[0-9]* *;[ @\\+]*else *if *\( *\1 *[<>]=? *[0-9]* *\) *\1 *= *[0-9]* *;' >$TMP && printf "\nav_clip / av_clip_uint8 / av_clip_int16 / ...\n"
6c2dd77e
MN
149cat $TMP | tr '@' '\n'
150
ff3be572 151cat $* | tr '\n' '@' | $EGREP --color=always -o '\+ *if *\( *([A-Za-z0-9_]*) *[<>]=? *([A-Za-z0-9_]*) *\)[ @\\+]*(\1|\2) *= *(\1|\2) *;' >$TMP && printf "\nFFMIN/FFMAX\n"
6c2dd77e
MN
152cat $TMP | tr '@' '\n'
153
ff3be572 154cat $* | tr '\n' '@' | $EGREP --color=always -o '\+ *if *\( *([A-Za-z0-9_]*) *\)[ @\\+]*av_free(p|) *\( *(&|) *\1[^-.]' >$TMP && printf "\nav_free(NULL) is safe\n"
6c2dd77e
MN
155cat $TMP | tr '@' '\n'
156
ff3be572 157cat $* | tr '\n' '@' | $EGREP --color=always -o '[^a-zA-Z0-9_]([a-zA-Z0-9_]*) *= *av_malloc *\([^)]*\)[ @;\\+]*memset *\( *\1' >$TMP && printf "\nav_mallocz()\n"
6c2dd77e
MN
158cat $TMP | tr '@' '\n'
159
160
161# doesnt work
ff3be572 162#cat $* | tr '\n' '@' | $EGREP -o '[^a-zA-Z_0-9]([a-zA-Z][a-zA-Z_0-9]*) *=[^=].*\1' | $EGREP -o '[^a-zA-Z_0-9]([a-zA-Z][a-zA-Z_0-9]*) *=[^=].*\1 *=[^=]' >$TMP && printf "\nPossibly written 2x before read\n"
6c2dd77e
MN
163#cat $TMP | tr '@' '\n'
164
165exit
166
167TODO/idea list:
168
169for all demuxers & muxers
ff3be572 170 $EGREP for "avctx->priv_data"
6c2dd77e
MN
171
172vertical align =
173/* and * align
174arrays fitting in smaller types
175variables written to twice with no interspaced read
176memset(block, 0, 6*64*sizeof(DCTELEM)); -> clear_blocks
177check existence of long_name in AVCodec
178check that the patch does not touch codec & (de)muxer layer at the same time ->split
179
180write a regression test containing at least a line that triggers each warning once