Run check_keywords.pl anytime gram.c is rebuilt.

This script is a bit slow, but still it only takes a fraction of the time
the bison run does, so the overhead doesn't seem intolerable.  And we
definitely need some mechanical aid here, because people keep missing
the need to add new keywords to the appropriate keyword-list production.

While at it, I moved check_keywords.pl from src/tools into
src/backend/parser where it's actually used, and did some very minor
cleanup on the script.

2 files changed, 231 insertions, 4 deletions

diff --git a/src/backend/parser/Makefile b/src/backend/parser/Makefile
index 00e8e88e9c2..1f48e16a76a 100644
--- a/src/backend/parser/Makefile
+++ b/src/backend/parser/Makefile
@@ -41,6 +41,7 @@ endif
 gram.h: gram.c ;
 
 gram.c: gram.y
+	$(PERL) $(srcdir)/check_keywords.pl $< $(top_srcdir)/src/include/parser/kwlist.h
 ifdef BISON
 	$(BISON) -d $(BISONFLAGS) -o $@ $<
 else
@@ -65,7 +66,3 @@ gram.o keywords.o parser.o: gram.h
 # are not cleaned here.
 clean distclean maintainer-clean:
 	rm -f lex.backup
-
-
-maintainer-check:
-	$(PERL) $(top_srcdir)/src/tools/check_keywords.pl $(top_srcdir)
diff --git a/src/backend/parser/check_keywords.pl b/src/backend/parser/check_keywords.pl
new file mode 100644
index 00000000000..274dd28ae6e
--- /dev/null
+++ b/src/backend/parser/check_keywords.pl
@@ -0,0 +1,230 @@
+#!/usr/bin/perl
+
+# Check that the keyword lists in gram.y and kwlist.h are sane.
+# Usage: check_keywords.pl gram.y kwlist.h
+
+# src/backend/parser/check_keywords.pl
+# Copyright (c) 2009-2012, PostgreSQL Global Development Group
+
+use warnings;
+use strict;
+
+my $gram_filename = $ARGV[0];
+my $kwlist_filename = $ARGV[1];
+
+my $errors = 0;
+
+sub error(@)
+{
+	print STDERR @_;
+	$errors = 1;
+}
+
+$, = ' ';     # set output field separator
+$\ = "\n";    # set output record separator
+
+my %keyword_categories;
+$keyword_categories{'unreserved_keyword'}     = 'UNRESERVED_KEYWORD';
+$keyword_categories{'col_name_keyword'}       = 'COL_NAME_KEYWORD';
+$keyword_categories{'type_func_name_keyword'} = 'TYPE_FUNC_NAME_KEYWORD';
+$keyword_categories{'reserved_keyword'}       = 'RESERVED_KEYWORD';
+
+open(GRAM, $gram_filename) || die("Could not open : $gram_filename");
+
+my ($S, $s, $k, $n, $kcat);
+my $comment;
+my @arr;
+my %keywords;
+
+line: while (<GRAM>)
+{
+	chomp;    # strip record separator
+
+	$S = $_;
+
+	# Make sure any braces are split
+	$s = '{', $S =~ s/$s/ { /g;
+	$s = '}', $S =~ s/$s/ } /g;
+
+	# Any comments are split
+	$s = '[/][*]', $S =~ s#$s# /* #g;
+	$s = '[*][/]', $S =~ s#$s# */ #g;
+
+	if (!($kcat))
+	{
+		# Is this the beginning of a keyword list?
+		foreach $k (keys %keyword_categories)
+		{
+			if ($S =~ m/^($k):/)
+			{
+				$kcat = $k;
+				next line;
+			}
+		}
+		next line;
+	}
+
+	# Now split the line into individual fields
+	$n = (@arr = split(' ', $S));
+
+	# Ok, we're in a keyword list. Go through each field in turn
+	for (my $fieldIndexer = 0; $fieldIndexer < $n; $fieldIndexer++)
+	{
+		if ($arr[$fieldIndexer] eq '*/' && $comment)
+		{
+			$comment = 0;
+			next;
+		}
+		elsif ($comment)
+		{
+			next;
+		}
+		elsif ($arr[$fieldIndexer] eq '/*')
+		{
+			# start of a multiline comment
+			$comment = 1;
+			next;
+		}
+		elsif ($arr[$fieldIndexer] eq '//')
+		{
+			next line;
+		}
+
+		if ($arr[$fieldIndexer] eq ';')
+		{
+			# end of keyword list
+			$kcat = '';
+			next;
+		}
+
+		if ($arr[$fieldIndexer] eq '|')
+		{
+			next;
+		}
+
+		# Put this keyword into the right list
+		push @{ $keywords{$kcat} }, $arr[$fieldIndexer];
+	}
+}
+close GRAM;
+
+# Check that each keyword list is in alphabetical order (just for neatnik-ism)
+my ($prevkword, $kword, $bare_kword);
+foreach $kcat (keys %keyword_categories)
+{
+	$prevkword = '';
+
+	foreach $kword (@{ $keywords{$kcat} })
+	{
+		# Some keyword have a _P suffix. Remove it for the comparison.
+		$bare_kword = $kword;
+		$bare_kword =~ s/_P$//;
+		if ($bare_kword le $prevkword)
+		{
+			error
+			  "'$bare_kword' after '$prevkword' in $kcat list is misplaced";
+		}
+		$prevkword = $bare_kword;
+	}
+}
+
+# Transform the keyword lists into hashes.
+# kwhashes is a hash of hashes, keyed by keyword category id,
+# e.g. UNRESERVED_KEYWORD.
+# Each inner hash is keyed by keyword id, e.g. ABORT_P, with a dummy value.
+my %kwhashes;
+while (my ($kcat, $kcat_id) = each(%keyword_categories))
+{
+	@arr = @{ $keywords{$kcat} };
+
+	my $hash;
+	foreach my $item (@arr) { $hash->{$item} = 1; }
+
+	$kwhashes{$kcat_id} = $hash;
+}
+
+# Now read in kwlist.h
+
+open(KWLIST, $kwlist_filename) || die("Could not open : $kwlist_filename");
+
+my $prevkwstring = '';
+my $bare_kwname;
+my %kwhash;
+kwlist_line: while (<KWLIST>)
+{
+	my ($line) = $_;
+
+	if ($line =~ /^PG_KEYWORD\(\"(.*)\", (.*), (.*)\)/)
+	{
+		my ($kwstring) = $1;
+		my ($kwname)   = $2;
+		my ($kwcat_id) = $3;
+
+		# Check that the list is in alphabetical order (critical!)
+		if ($kwstring le $prevkwstring)
+		{
+			error
+			  "'$kwstring' after '$prevkwstring' in kwlist.h is misplaced";
+		}
+		$prevkwstring = $kwstring;
+
+		# Check that the keyword string is valid: all lower-case ASCII chars
+		if ($kwstring !~ /^[a-z_]+$/)
+		{
+			error
+"'$kwstring' is not a valid keyword string, must be all lower-case ASCII chars";
+		}
+
+		# Check that the keyword name is valid: all upper-case ASCII chars
+		if ($kwname !~ /^[A-Z_]+$/)
+		{
+			error
+"'$kwname' is not a valid keyword name, must be all upper-case ASCII chars";
+		}
+
+		# Check that the keyword string matches keyword name
+		$bare_kwname = $kwname;
+		$bare_kwname =~ s/_P$//;
+		if ($bare_kwname ne uc($kwstring))
+		{
+			error
+"keyword name '$kwname' doesn't match keyword string '$kwstring'";
+		}
+
+		# Check that the keyword is present in the grammar
+		%kwhash = %{ $kwhashes{$kwcat_id} };
+
+		if (!(%kwhash))
+		{
+			error "Unknown keyword category: $kwcat_id";
+		}
+		else
+		{
+			if (!($kwhash{$kwname}))
+			{
+				error "'$kwname' not present in $kwcat_id section of gram.y";
+			}
+			else
+			{
+				# Remove it from the hash, so that we can
+				# complain at the end if there's keywords left
+				# that were not found in kwlist.h
+				delete $kwhashes{$kwcat_id}->{$kwname};
+			}
+		}
+	}
+}
+close KWLIST;
+
+# Check that we've paired up all keywords from gram.y with lines in kwlist.h
+while (my ($kwcat, $kwcat_id) = each(%keyword_categories))
+{
+	%kwhash = %{ $kwhashes{$kwcat_id} };
+
+	for my $kw (keys %kwhash)
+	{
+		error "'$kw' found in gram.y $kwcat category, but not in kwlist.h";
+	}
+}
+
+exit $errors;