3 # Empire - A multi-player, client/server Internet based war game.
4 # Copyright (C) 1986-2010, Dave Pare, Jeff Bailey, Thomas Ruschak,
5 # Ken Stevens, Steve McClure
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 2 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 # See files README, COPYING and CREDITS in the root of the source
24 # tree for related information and legal notices. It is expected
25 # that future projects/authors will amend these files as needed.
29 # findsubj.pl: Find info subjects, update subjects.mk
31 # Known contributors to this file:
32 # Ken Stevens (when it was still info.pl)
33 # Markus Armbruster, 2006-2008
36 # Usage: findsubj.pl INFO-FILE...
37 # Run it at the root of the build tree. This updates the make include
38 # file subjects.mk, which guides the remaking of info index files.
40 # --- Global variables ---
41 # @Subjects Existing subjects
42 # $filename The name of the current info file
44 # TOPIC's info file name
45 # $chapter{TOPIC} TOPIC's chapter (first arg to .TH)
47 # TOPIC's SEE ALSO items (.SA argument)
48 # $sanr{TOPIC} Line number of TOPIC's .SA request
50 # info files for SUBJECT separated by space
52 # --- File handles ---
53 # F Filehandle for info page sources and makefiles
57 # read_make_var Read a variable value from a makefile
58 # parse_file Read an info file
59 # parse_see_also Create %subjfil from %see_also
60 # error Print an integrity error to STDERR and exit with code 1.
67 our (%filename, %chapter, %see_also, %sanr);
68 our ($filename, %subjfil);
71 our @Subjects = split(' ', read_make_var("subjects", "subjects.mk", ""));
78 # Create %subjfil from %see_also
79 for my $t (sort keys %see_also) {
83 # Update @Subjects from %subjfil
84 for my $t (@Subjects) {
85 print STDERR "WARNING: The subject $t has been removed.\n"
86 unless exists $subjfil{$t};
88 for my $t (keys %subjfil) {
89 unless (grep(/^$t$/, @Subjects)) {
90 print STDERR "WARNING: $t is a NEW subject\n";
91 my $fname = "info/$t.t";
93 print STDERR "File $fname exists\n";
98 @Subjects = sort keys %subjfil;
101 open(F, ">subjects.mk")
102 or die "Can't open subjects.mk for writing: $!";
103 print F "# DO NOT EDIT THIS FILE. It was automatically generated by findsubj.pl\n";
104 print F "subjects := " . join(' ', @Subjects) . "\n";
105 for my $t (@Subjects) {
106 print F "info/$t.t:$subjfil{$t}\n";
112 # Read a variable value from a makefile
114 my ($var, $fname, $dflt) = @_;
117 unless (open(F, "<$fname")) {
118 return $dflt if $! == ENOENT and defined $dflt;
119 die "Can't open $fname: $!";
122 if (/^[ \t]*\Q$var\E[ \t]:?=*(.*)/) {
128 $val or die "Can't find $var in $fname";
133 # Parse .TH into %chapter and .SA into %see_also, %sanr
139 $topic =~ s,.*/([^/]*)\.t$,$1,;
140 $filename{$topic} = $filename;
142 open(F, "<$filename")
143 or die "Can't open $filename: $!";
146 if (/^\.TH (\S+) (\S.+\S)$/) {
147 $chapter{$topic} = $1;
149 error("The first line in the file must be a .TH request");
157 if (/^\.SA "([^\"]*)"/) {
158 $see_also{$topic} = $1;
161 error("Incorrect .SA Syntax. Syntax should be '.SA \"item1, item2\"'");
165 error("Multiple .SA requests. Each file may contain at most one.") if /^\.SA/;
168 error(".SA request is missing");
174 # Create %subjfil from %see_also
177 my @see_also = split(/, /, $see_also{$topic});
178 my $wanted = $chapter{$topic};
179 my $found; # found a subject?
181 $wanted = undef if $wanted eq 'Concept' or $wanted eq 'Command';
182 $filename = $filename{$topic};
185 if (!exists $see_also{$_}) { # is this entry a subject?
186 $subjfil{$_} .= " info/$topic.t";
189 if ($wanted && $_ eq $wanted) {
195 error("No subject listed in .SA") unless $found;
196 error("Chapter $wanted not listed in .SA") if $wanted;
199 # Print an integrity error message and exit with code 1
203 print STDERR "findsubj.pl:$filename:$.: $error\n";