diff mbox

[review,RFC,gdb/contrib] Add words.sh script

Message ID gerrit.1571935190000.I7b119c9a4519cdbf62a3243d1df2927c80813e8b@gnutoolchain-gerrit.osci.io
State New
Headers show

Commit Message

Simon Marchi (Code Review) Oct. 24, 2019, 4:39 p.m. UTC
Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/282
......................................................................

[RFC][gdb/contrib] Add words.sh script

Add a script that takes a list of files as arguments and output a list of
words from the C comments with their frequencies.

For:
...
$ ./gdb/contrib/words.sh $(find gdb -type f -name "*.c" -o -name "*.h")
...
it generates a list of ~15000 words prefixed with frequency.

This could be used to generate a dictionary that is kept as part of the
sources, against which new code can be checked, generating a warning or
error.  The hope is that misspellings would trigger this frequently, and rare
words rarely, otherwise the burden of updating the dictionary would be too
much.

And for:
...
$ ./gdb/contrib/words.sh -f 1 $(find gdb -type f -name "*.c" -o -name "*.h")
...
it generates a list of ~5000 words with frequency 1.

This can be used to scan for misspellings manually.

Change-Id: I7b119c9a4519cdbf62a3243d1df2927c80813e8b
---
A gdb/contrib/words.sh
1 file changed, 107 insertions(+), 0 deletions(-)

Comments

Simon Marchi (Code Review) Oct. 25, 2019, 5:51 p.m. UTC | #1
Luis Machado has posted comments on this change.

Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/282
......................................................................


Patch Set 1:

Thanks, this is pretty cool! I ran a few examples and it seems very useful.

I'd put your example of scanning all .[c|h] files into the script itself, so it is immediately obvious how to perform such action.

Something that i tried out of the box and that gave me a weird result was "./words --help". It listed words from awk i think, which is a bit odd. But since it is a basic script, it's not a big deal.
Simon Marchi (Code Review) Oct. 25, 2019, 5:51 p.m. UTC | #2
Luis Machado has posted comments on this change.

Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/282
......................................................................


Patch Set 1: Code-Review+1
Simon Marchi (Code Review) Nov. 5, 2019, 3:40 p.m. UTC | #3
Tom Tromey has posted comments on this change.

Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/282
......................................................................


Patch Set 1: Code-Review+2

Thanks this seems fine to me!
Simon Marchi (Code Review) Nov. 5, 2019, 4:21 p.m. UTC | #4
Simon Marchi has posted comments on this change.

Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/282
......................................................................


Patch Set 1:

I'd suggest running shellcheck (https://www.shellcheck.net/) on it and fixing the few small warnings it gives.
Simon Marchi (Code Review) Nov. 7, 2019, 9:45 a.m. UTC | #5
Tom de Vries has posted comments on this change.

Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/282
......................................................................


Patch Set 1:

> Patch Set 1:
> 
> Thanks, this is pretty cool! I ran a few examples and it seems very useful.
> 
> I'd put your example of scanning all .[c|h] files into the script itself, so it is immediately obvious how to perform such action.
> 

Done.

> Something that i tried out of the box and that gave me a weird result was "./words --help". It listed words from awk i think, which is a bit odd. But since it is a basic script, it's not a big deal.

Fixed by adding -- to the awk command line.

Now prints:
...
$ ./gdb/contrib/words.sh --help
awk: /tmp/tmp.XttLdZXpeI:2: fatal: cannot open file `--help' for reading (No such file or directory)
...
Simon Marchi (Code Review) Nov. 7, 2019, 9:46 a.m. UTC | #6
Tom de Vries has posted comments on this change.

Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/282
......................................................................


Patch Set 2:

> Patch Set 1:
> 
> I'd suggest running shellcheck (https://www.shellcheck.net/) on it and fixing the few small warnings it gives.

Done.
diff mbox

Patch

diff --git a/gdb/contrib/words.sh b/gdb/contrib/words.sh
new file mode 100755
index 0000000..ad6ec2b
--- /dev/null
+++ b/gdb/contrib/words.sh
@@ -0,0 +1,107 @@ 
+#!/bin/sh
+
+# Copyright (C) 2019 Free Software Foundation, Inc.
+# 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, see <http://www.gnu.org/licenses/>.
+
+# This script intends to facilitate spell checking of comments in C sources.
+# It:
+# - extracts comments from C files
+# - transforms the comments into a list of lowercase words
+# - prefixes each word with the frequency
+# - filters out words within a frequency range
+# - sorts the words, longest first
+
+dir=$(cd $(dirname $0); pwd -P)
+
+minfreq=
+maxfreq=
+while [ $# -gt 0 ]; do
+    case "$1" in
+	--freq|-f)
+	    minfreq=$2
+	    maxfreq=$2
+	    shift 2
+	    ;;
+	--min)
+	    minfreq=$2
+	    if [ "$maxfreq" = "" ]; then
+		maxfreq=0
+	    fi
+	    shift 2
+	    ;;
+	--max)
+	    maxfreq=$2
+	    if [ "$minfreq" = "" ]; then
+		minfreq=0
+	    fi
+	    shift 2
+	    ;;
+	*)
+	    break;
+	    ;;
+    esac
+done
+
+if [ "$minfreq" = "" ] && [ "$maxfreq" = "" ]; then
+    minfreq=0
+    maxfreq=0
+fi
+
+awkfile=$(mktemp)
+
+cat > $awkfile <<EOF
+BEGIN {
+    in_comment=0
+}
+
+// {
+    line=\$0
+}
+
+/\/\*/ {
+    in_comment=1
+    sub(/.*\/\*/, "", line)
+}
+
+/\*\// {
+    sub(/\*\/.*/, "", line)
+    in_comment=0
+    print line
+    next
+}
+
+// {
+    if (in_comment) {
+	print line
+    }
+}
+EOF
+
+awk \
+    -f $awkfile \
+    "$@" \
+    | sed 's/[%^$~#{}`&=@,. \t\/_-()|<>\+\*]/\n/g' \
+    | sed 's/\[/\n/g' \
+    | sed 's/\]/\n/g' \
+    | sed 's/[0-9][0-9]*/\n/g' \
+    | tr '[:upper:]' '[:lower:]' \
+    | sed 's/[ \t]*//g' \
+    | sort \
+    | uniq -c \
+    | awk "{ if (($minfreq == 0 || $minfreq <= \$1) && ($maxfreq == 0 || \$1 <= $maxfreq)) { print \$0; } }" \
+    | awk '{ print length($0) " " $0; }' \
+    | sort -n -r \
+    | cut -d ' ' -f 2-
+
+rm -f $awkfile