3 # Empire - A multi-player, client/server Internet based war game.
4 # Copyright (C) 1986-2013, Dave Pare, Jeff Bailey, Thomas Ruschak,
5 # Ken Stevens, Steve McClure, Markus Armbruster
7 # Empire 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 3 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, see <http://www.gnu.org/licenses/>.
22 # See files README, COPYING and CREDITS in the root of the source
23 # tree for related information and legal notices. It is expected
24 # that future projects/authors will amend these files as needed.
28 # mksubj.pl: Update the subject index pages
30 # Known contributors to this file:
31 # Ken Stevens (when it was still info.pl)
32 # Markus Armbruster, 2006-2013
34 # Usage: mksubj.pl SUBJECT... INFO-FILE...
36 # Read the INFO-FILE..., update info/SUBJECT.t for each SUBJECT.
42 # The chapters, in order
43 my @Chapters = qw/Introduction Concept Command Server/;
45 my @Levels = qw/Basic Expert Obsolete/;
47 # $Subjects{SUBJECT} is a reference to an an anonymous array
48 # containing SUBJECT's topics
51 # $filename{TOPIC} is TOPIC's file name
53 # $long{TOPIC} is true when TOPIC's page is "long"
55 # $chapter{TOPIC} is TOPIC's chapter (first arg to .TH)
57 # $desc{TOPIC} is a one line description of TOPIC (second arg to .NA)
59 # $level{TOPIC} is TOPIC's difficulty level (arg to .LV)
65 while ($#ARGV >= 0 && $ARGV[0] !~ /\.t$/) {
66 $Subjects{shift @ARGV} = [];
70 $filename{fn2topic($_)} = $_;
77 for (keys %Subjects) {
83 $fn =~ s,.*/([^/]*)\.t$,$1,;
88 # Set $filename, $long{TOPIC}, $chapter{TOPIC}, $desc{TOPIC},
93 my $topic = fn2topic($filename);
97 or die "Can't stat $filename: $!";
98 $long{$topic} = $st->size > 9999;
100 open(F, "<$filename")
101 or die "Can't open $filename: $!";
104 if (/^\.TH (\S+) (\S.+\S)$/) {
105 if (!grep(/^$1$/, @Chapters)) {
106 error("First argument to .TH was '$1', which is not a known chapter");
108 $chapter{$topic} = $1;
109 if ($1 eq "Command" && $2 ne "\U$topic") {
110 error("Second argument to .TH was '$2' but it should be '\U$topic'");
113 error("The first line in the file must be a .TH request");
117 if (/^\.NA (\S+) "(\S.+\S)"$/) {
119 error("First argument to .NA was '$1' but it should be '$topic'");
123 error("The second line in the file must be a .NA request");
127 if (/^\.LV (\S+)$/) {
128 if (!grep(/^$1$/, @Levels)) {
129 error("The argument to .LV was '$1', which is not a known level");
133 error("The third line in the file must be a .LV request");
141 if (/^\.SA "([^\"]*)"/) {
142 parse_see_also($topic, $1);
144 error("Incorrect .SA Syntax. Syntax should be '.SA \"item1, item2\"'");
148 error("Multiple .SA requests. Each file may contain at most one.") if /^\.SA/;
151 error(".SA request is missing");
158 my ($topic, $sa) = @_;
159 my $wanted = $chapter{$topic};
160 my $found; # found a subject?
162 $wanted = undef if $wanted eq 'Concept' or $wanted eq 'Command';
164 for (split(/, /, $sa)) {
165 next if exists $filename{$_};
166 error("Unknown topic $_ in .SA") unless exists $Subjects{$_};
167 push @{$Subjects{$_}}, $topic;
169 if ($wanted && $_ eq $wanted) {
174 error("No subject listed in .SA") unless $found;
175 error("Chapter $wanted not listed in .SA") if $wanted;
178 # Update a Subject.t file
181 my $fname = "info/$subj.t";
182 my @topics = @{$Subjects{$subj}};
184 my ($any_topic, $any_basic, $any_obsolete, $any_long);
187 for my $topic (@topics) {
188 $largest = $topic if length $topic > length $largest;
191 $out .= '.\" DO NOT EDIT THIS FILE. It was automatically generated by mksubj.pl'."\n";
192 $out .= ".TH Subject \U$subj\n";
194 $out .= ".in \\w'$largest" . "XX\\0\\0\\0\\0'u\n";
196 for my $chap (@Chapters) {
198 for my $topic (@topics) {
200 next if $chapter{$topic} ne $chap;
201 $out .= ".s1\n" if $empty;
204 if ($level{$topic} eq 'Basic') {
208 if ($level{$topic} eq 'Obsolete') {
216 $flags = sprintf("%-2s", $flags);
217 $out .= ".L \"$topic $flags\"\n";
218 $out .= "$desc{$topic}\n";
221 unless ($any_topic) {
222 print STDERR "$0: Subject $subj has no topics\n";
227 . "For info on a particular subject, type \"info <subject>\" where <subject> is\n"
228 . "one of the subjects listed above.\n";
229 $out .= "Subjects marked by * are the most important and should be read by new players.\n"
231 $out .= "Subjects marked by + are obsolete.\n"
233 $out .= "Unusually long subjects are marked with a !.\n"
236 return if (same_contents($fname, $out));
237 open(SUBJ, ">$fname")
238 or die "Can't open $fname for writing: $!";
244 my ($fname, $contents) = @_;
247 if (!open(SUBJ, "<$fname")) {
248 return 0 if ($!{ENOENT});
249 die "Can't open $fname for reading: $!";
253 return $contents eq $old;
256 # Print an integrity error message and exit with code 1
260 print STDERR "mksubj.pl:$filename:$.: $error\n";