#!/usr/bin/perl
#
# Empire - A multi-player, client/server Internet based war game.
-# Copyright (C) 1986-2013, Dave Pare, Jeff Bailey, Thomas Ruschak,
+# Copyright (C) 1986-2014, Dave Pare, Jeff Bailey, Thomas Ruschak,
# Ken Stevens, Steve McClure, Markus Armbruster
#
# Empire is free software: you can redistribute it and/or modify
#
# ---
#
-# mksubj.pl: Create the index for a subject
+# mksubj.pl: Update the subject index pages
#
# Known contributors to this file:
# Ken Stevens (when it was still info.pl)
-# Markus Armbruster, 2006
+# Markus Armbruster, 2006-2013
#
-
-# Usage: mksubj.pl OUTFILE INFILE...
-# The INFILE... contain all the topics belonging to a subject. Read
-# and check the information required for the index from them, write
-# the index to OUTFILE.
+# Usage: mksubj.pl SUBJECT... INFO-FILE...
+#
+# Read the INFO-FILE..., update info/SUBJECT.t for each SUBJECT.
use strict;
use warnings;
-use File::stat;
# The chapters, in order
my @Chapters = qw/Introduction Concept Command Server/;
my @Levels = qw/Basic Expert Obsolete/;
+# $Subjects{SUBJECT} is a reference to an an anonymous array
+# containing SUBJECT's topics
+my %Subjects;
+
+# $filename{TOPIC} is TOPIC's file name
+my %filename;
+# $lines{TOPIC} is the number of lines in $filename{TOPIC}
+my %lines;
+# $chapter{TOPIC} is TOPIC's chapter (first arg to .TH)
+my %chapter;
+# $desc{TOPIC} is a one line description of TOPIC (second arg to .NA)
+my %desc;
+# $level{TOPIC} is TOPIC's difficulty level (arg to .LV)
+my %level;
+
+# current info file
my $filename;
-my (%subject, %level, %desc, %long, %cnt);
-my $largest = "";
-my $out = shift @ARGV;
-$out =~ /([^\/]*)\.t$/
- or die "Strange subject file name $out";
-my $subj = $1;
+while ($#ARGV >= 0 && $ARGV[0] !~ /\.t$/) {
+ $Subjects{shift @ARGV} = [];
+}
for (@ARGV) {
- my ($topic, $chap, $lvl, $desc, $long) = parse_file($_);
- $largest = $topic if length $topic > length $largest;
- $subject{$chap} .= "$topic\n";
- $level{$topic} = $lvl;
- $cnt{$lvl}++;
- $desc{$topic} = $desc;
- $long{$topic} = $long;
- $cnt{'long'}++ if $long;
+ $filename{fn2topic($_)} = $_;
}
-open(SUBJ, ">$out")
- or die "Can't open $out for writing: $!";
-
-print SUBJ '.\" DO NOT EDIT THIS FILE. It was automatically generated by mksubj.pl'."\n";
-print SUBJ ".TH Subject \U$subj\n";
-$largest =~ s/-/M/g;
-print SUBJ ".in \\w'$largest", "XX\\0\\0\\0\\0'u\n";
-
-for my $chap (@Chapters) {
- next unless exists $subject{$chap};
- print SUBJ ".s1\n";
- for (split(/\n/, $subject{$chap})) {
- my $flags = "";
- $flags .= "*" if $level{$_} eq 'Basic';
- $flags .= "+" if $level{$_} eq 'Obsolete';
- $flags .= "!" if $long{$_};
- $flags = sprintf("%-2s", $flags);
- print SUBJ ".L \"$_ $flags\"\n";
- print SUBJ "$desc{$_}\n";
- }
+for (@ARGV) {
+ parse_file($_);
}
-print SUBJ <<EOF;
-.s1
-.in 0
-For info on a particular subject, type "info <subject>" where <subject> is
-one of the subjects listed above.
-EOF
-print SUBJ <<EOF if $cnt{'Basic'};
-Subjects marked by * are the most important and should be read by new
-players.
-EOF
-print SUBJ <<EOF if $cnt{'Obsolete'};
-Subjects marked by + are obsolete.
-EOF
-print SUBJ <<EOF if $cnt{'long'};
-Unusually long subjects are marked with a !.
-EOF
-close SUBJ;
+for (keys %Subjects) {
+ update_subj($_);
+}
+sub fn2topic {
+ my ($fn) = @_;
+ $fn =~ s,.*/([^/]*)\.t$,$1,;
+ return $fn;
+}
+# Parse an info file
+# Set $filename, $lines{TOPIC}, $chapter{TOPIC}, $desc{TOPIC},
+# $level{TOPIC}.
+# Update %Subjects.
sub parse_file {
($filename) = @_;
- my ($topic, $chap, $lvl, $desc, $long, $st);
-
- $topic = $filename;
- $topic =~ s,.*/([^/]*)\.t$,$1,;
-
- $st = stat $filename
- or die "Can't stat $filename: $!";
- $long = $st->size > 9999;
+ my $topic = fn2topic($filename);
open(F, "<$filename")
or die "Can't open $filename: $!";
if (!grep(/^$1$/, @Chapters)) {
error("First argument to .TH was '$1', which is not a known chapter");
}
- $chap = $1;
+ $chapter{$topic} = $1;
if ($1 eq "Command" && $2 ne "\U$topic") {
error("Second argument to .TH was '$2' but it should be '\U$topic'");
}
if ($topic ne $1) {
error("First argument to .NA was '$1' but it should be '$topic'");
}
- $desc = $2;
+ $desc{$topic} = $2;
} else {
error("The second line in the file must be a .NA request");
}
if (!grep(/^$1$/, @Levels)) {
error("The argument to .LV was '$1', which is not a known level");
}
- $lvl = $1;
+ $level{$topic} = $1;
} else {
error("The third line in the file must be a .LV request");
}
+ while (<F>) {
+ last if /^\.SA/;
+ }
+
+ if ($_) {
+ if (/^\.SA "([^\"]*)"/) {
+ parse_see_also($topic, $1);
+ } else {
+ error("Incorrect .SA argument, expecting '.SA \"item1, item2\"'");
+ }
+ } else {
+ error(".SA request is missing");
+ }
+
+ if (<F>) {
+ error(".SA request must be the last line");
+ }
+
+ $lines{$topic} = $.;
close F;
+}
- return ($topic, $chap, $lvl, $desc, $long);
+sub parse_see_also {
+ my ($topic, $sa) = @_;
+ my $wanted = $chapter{$topic};
+ my $found; # found a subject?
+
+ $wanted = undef if $wanted eq 'Concept' or $wanted eq 'Command';
+
+ for (split(/, /, $sa)) {
+ next if exists $filename{$_};
+ error("Unknown topic $_ in .SA") unless exists $Subjects{$_};
+ push @{$Subjects{$_}}, $topic;
+ $found = 1;
+ if ($wanted && $_ eq $wanted) {
+ $wanted = undef;
+ }
+ }
+
+ error("No subject listed in .SA") unless $found;
+ error("Chapter $wanted not listed in .SA") if $wanted;
+}
+
+# Update a Subject.t file
+sub update_subj {
+ my ($subj) = @_;
+ my $fname = "info/$subj.t";
+ my @topics = @{$Subjects{$subj}};
+ my $out = "";
+ my ($any_topic, $any_basic, $any_obsolete, $any_long);
+
+ my $largest = "";
+ for my $topic (@topics) {
+ $largest = $topic if length $topic > length $largest;
+ }
+
+ $out .= '.\" DO NOT EDIT THIS FILE. It was automatically generated by mksubj.pl'."\n";
+ $out .= ".TH Subject \U$subj\n";
+ $largest =~ s/-/M/g;
+ $out .= ".in \\w'$largest" . "XX\\0\\0\\0\\0'u\n";
+
+ for my $chap (@Chapters) {
+ my $empty = 1;
+ for my $topic (@topics) {
+ $any_topic = 1;
+ next if $chapter{$topic} ne $chap;
+ $out .= ".s1\n" if $empty;
+ $empty = 0;
+ my $flags = "";
+ if ($level{$topic} eq 'Basic') {
+ $flags .= "*";
+ $any_basic = 1;
+ }
+ if ($level{$topic} eq 'Obsolete') {
+ $flags .= "+";
+ $any_obsolete = 1;
+ }
+ if ($lines{$topic} > 300) {
+ # TODO use formatted line count
+ $flags .= "!";
+ $any_long = 1;
+ }
+ $flags = sprintf("%-2s", $flags);
+ $out .= ".L \"$topic $flags\"\n";
+ $out .= "$desc{$topic}\n";
+ }
+ }
+ unless ($any_topic) {
+ print STDERR "$0: Subject $subj has no topics\n";
+ exit 1;
+ }
+ $out .= ".s1\n"
+ . ".in 0\n"
+ . "For info on a particular topic, type \"info <topic>\" where <topic> is\n"
+ . "one of the topics listed above.\n";
+ $out .= "Topics marked by * are the most important and should be read by new players.\n"
+ if $any_basic;
+ $out .= "Topics marked by + are obsolete.\n"
+ if $any_obsolete;
+ $out .= "Topics with unusually long info are marked with a !.\n"
+ if $any_long;
+
+ return if (same_contents($fname, $out));
+ open(SUBJ, ">$fname")
+ or die "Can't open $fname for writing: $!";
+ print SUBJ $out;
+ close SUBJ;
+}
+
+sub same_contents {
+ my ($fname, $contents) = @_;
+ local $/;
+
+ if (!open(SUBJ, "<$fname")) {
+ return 0 if ($!{ENOENT});
+ die "Can't open $fname for reading: $!";
+ }
+ my $old = <SUBJ>;
+ close SUBJ;
+ return $contents eq $old;
}
# Print an integrity error message and exit with code 1
projects / empserver / blobdiff