1
0
mirror of https://github.com/postgres/postgres.git synced 2025-08-06 18:42:54 +03:00
Files
postgres/doc/src/sgml/generate-keywords-table.pl
Tom Lane 4d1563717f Doc: fix remaining over-length entries in SQL keywords table.
Even after the tweaking I did in commit 5545b69ae, some of the
longer keywords mentioned in the SQL standard don't fit the
available space in PDF output.

I experimented with various solutions like putting such keywords
on their own table lines, but everything looked ugly or confusing
or both; worse, the weirdness also appeared in the HTML version,
which (normally) doesn't need it.

The best answer seems to be to insert &zwsp; into long keywords
so that they can be broken into two lines when, and only when,
needed.  It doesn't look too awful if the break happens after
an underscore --- and fortunately, all the problematic keywords
have underscores.

Discussion: https://postgr.es/m/6916.1589146280@sss.pgh.pa.us
2020-05-11 20:03:55 -04:00

133 lines
2.4 KiB
Perl

#!/usr/bin/perl
#
# Generate the keywords table file
# Copyright (c) 2019-2020, PostgreSQL Global Development Group
use strict;
use warnings;
my @sql_versions = reverse sort ('1992', '2011', '2016');
my $srcdir = $ARGV[0];
my %keywords;
# read SQL keywords
foreach my $ver (@sql_versions)
{
foreach my $res ('reserved', 'nonreserved')
{
foreach my $file (glob "$srcdir/keywords/sql${ver}*-${res}.txt")
{
open my $fh, '<', $file or die;
while (<$fh>)
{
chomp;
$keywords{$_}{$ver}{$res} = 1;
}
close $fh;
}
}
}
# read PostgreSQL keywords
open my $fh, '<', "$srcdir/../../../src/include/parser/kwlist.h" or die;
while (<$fh>)
{
if (/^PG_KEYWORD\("(\w+)", \w+, (\w+)_KEYWORD\)/)
{
$keywords{ uc $1 }{'pg'}{ lc $2 } = 1;
}
}
close $fh;
# print output
print "<!-- autogenerated, do not edit -->\n";
print <<END;
<table id="keywords-table">
<title><acronym>SQL</acronym> Key Words</title>
<tgroup cols="5">
<colspec colname="col1" colwidth="5*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="2*"/>
<colspec colname="col4" colwidth="2*"/>
<colspec colname="col5" colwidth="2*"/>
<thead>
<row>
<entry>Key Word</entry>
<entry><productname>PostgreSQL</productname></entry>
END
foreach my $ver (@sql_versions)
{
my $s = ($ver eq '1992' ? 'SQL-92' : "SQL:$ver");
print " <entry>$s</entry>\n";
}
print <<END;
</row>
</thead>
<tbody>
END
foreach my $word (sort keys %keywords)
{
# Insert zwsp's into very long keywords, so that they can be broken
# into multiple lines in PDF format (or narrow HTML windows).
my $printword = $word;
$printword =~ s/_/_&zwsp;/g if (length($printword) > 20);
print " <row>\n";
print " <entry><token>$printword</token></entry>\n";
print " <entry>";
if ($keywords{$word}{pg}{'unreserved'})
{
print "non-reserved";
}
elsif ($keywords{$word}{pg}{'col_name'})
{
print "non-reserved (cannot be function or type)";
}
elsif ($keywords{$word}{pg}{'type_func_name'})
{
print "reserved (can be function or type)";
}
elsif ($keywords{$word}{pg}{'reserved'})
{
print "reserved";
}
print "</entry>\n";
foreach my $ver (@sql_versions)
{
print " <entry>";
if ($keywords{$word}{$ver}{'reserved'})
{
print "reserved";
}
elsif ($keywords{$word}{$ver}{'nonreserved'})
{
print "non-reserved";
}
print "</entry>\n";
}
print " </row>\n";
}
print <<END;
</tbody>
</tgroup>
</table>
END