yading@10: #! /usr/bin/perl
yading@10: 
yading@10: #   Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
yading@10: 
yading@10: # This file is part of GNU CC.
yading@10: 
yading@10: # GNU CC is free software; you can redistribute it and/or modify
yading@10: # it under the terms of the GNU General Public License as published by
yading@10: # the Free Software Foundation; either version 2, or (at your option)
yading@10: # any later version.
yading@10: 
yading@10: # GNU CC is distributed in the hope that it will be useful,
yading@10: # but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
yading@10: # GNU General Public License for more details.
yading@10: 
yading@10: # You should have received a copy of the GNU General Public License
yading@10: # along with GNU CC; see the file COPYING.  If not, write to
yading@10: # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
yading@10: # Boston, MA 02110-1301 USA
yading@10: 
yading@10: # This does trivial (and I mean _trivial_) conversion of Texinfo
yading@10: # markup to Perl POD format.  It's intended to be used to extract
yading@10: # something suitable for a manpage from a Texinfo document.
yading@10: 
yading@10: use warnings;
yading@10: 
yading@10: $output = 0;
yading@10: $skipping = 0;
yading@10: %chapters = ();
yading@10: @chapters_sequence = ();
yading@10: $chapter = "";
yading@10: @icstack = ();
yading@10: @endwstack = ();
yading@10: @skstack = ();
yading@10: @instack = ();
yading@10: $shift = "";
yading@10: %defs = ();
yading@10: $fnno = 1;
yading@10: $inf = "";
yading@10: @ibase = ();
yading@10: 
yading@10: while ($_ = shift) {
yading@10:     if (/^-D(.*)$/) {
yading@10:         if ($1 ne "") {
yading@10:             $flag = $1;
yading@10:         } else {
yading@10:             $flag = shift;
yading@10:         }
yading@10:         $value = "";
yading@10:         ($flag, $value) = ($flag =~ /^([^=]+)(?:=(.+))?/);
yading@10:         die "no flag specified for -D\n"
yading@10:             unless $flag ne "";
yading@10:         die "flags may only contain letters, digits, hyphens, dashes and underscores\n"
yading@10:             unless $flag =~ /^[a-zA-Z0-9_-]+$/;
yading@10:         $defs{$flag} = $value;
yading@10:     } elsif (/^-I(.*)$/) {
yading@10:         push @ibase, $1 ne "" ? $1 : shift;
yading@10:     } elsif (/^-/) {
yading@10:         usage();
yading@10:     } else {
yading@10:         $in = $_, next unless defined $in;
yading@10:         $out = $_, next unless defined $out;
yading@10:         usage();
yading@10:     }
yading@10: }
yading@10: 
yading@10: push @ibase, ".";
yading@10: 
yading@10: if (defined $in) {
yading@10:     $inf = gensym();
yading@10:     open($inf, "<$in") or die "opening \"$in\": $!\n";
yading@10:     push @ibase, $1 if $in =~ m|^(.+)/[^/]+$|;
yading@10: } else {
yading@10:     $inf = \*STDIN;
yading@10: }
yading@10: 
yading@10: if (defined $out) {
yading@10:     open(STDOUT, ">$out") or die "opening \"$out\": $!\n";
yading@10: }
yading@10: 
yading@10: while(defined $inf) {
yading@10: INF: while(<$inf>) {
yading@10:     # Certain commands are discarded without further processing.
yading@10:     /^\@(?:
yading@10:          [a-z]+index            # @*index: useful only in complete manual
yading@10:          |need                  # @need: useful only in printed manual
yading@10:          |(?:end\s+)?group      # @group .. @end group: ditto
yading@10:          |page                  # @page: ditto
yading@10:          |node                  # @node: useful only in .info file
yading@10:          |(?:end\s+)?ifnottex   # @ifnottex .. @end ifnottex: use contents
yading@10:         )\b/x and next;
yading@10: 
yading@10:     chomp;
yading@10: 
yading@10:     # Look for filename and title markers.
yading@10:     /^\@setfilename\s+([^.]+)/ and $fn = $1, next;
yading@10:     /^\@settitle\s+([^.]+)/ and $tl = postprocess($1), next;
yading@10: 
yading@10:     # Identify a man title but keep only the one we are interested in.
yading@10:     /^\@c\s+man\s+title\s+([A-Za-z0-9-]+)\s+(.+)/ and do {
yading@10:         if (exists $defs{$1}) {
yading@10:             $fn = $1;
yading@10:             $tl = postprocess($2);
yading@10:         }
yading@10:         next;
yading@10:     };
yading@10: 
yading@10:     /^\@include\s+(.+)$/ and do {
yading@10:         push @instack, $inf;
yading@10:         $inf = gensym();
yading@10: 
yading@10:         for (@ibase) {
yading@10:             open($inf, "<" . $_ . "/" . $1) and next INF;
yading@10:         }
yading@10:         die "cannot open $1: $!\n";
yading@10:     };
yading@10: 
yading@10:     /^\@chapter\s+([A-Za-z ]+)/ and do {
yading@10:         # close old chapter
yading@10:         $chapters{$chapter_name} .= postprocess($chapter) if ($chapter_name);
yading@10: 
yading@10:         # start new chapter
yading@10:         $chapter_name = $1, push (@chapters_sequence, $chapter_name) unless $skipping;
yading@10:         $chapters{$chapter_name} = "" unless exists $chapters{$chapter_name};
yading@10:         $chapter = "";
yading@10:         $output = 1;
yading@10:         next;
yading@10:     };
yading@10: 
yading@10:     /^\@bye/ and do {
yading@10:         # close old chapter
yading@10:         $chapters{$chapter_name} .= postprocess($chapter) if ($chapter_name);
yading@10:         last INF;
yading@10:     };
yading@10: 
yading@10:     # handle variables
yading@10:     /^\@set\s+([a-zA-Z0-9_-]+)\s*(.*)$/ and do {
yading@10:         $defs{$1} = $2;
yading@10:         next;
yading@10:     };
yading@10:     /^\@clear\s+([a-zA-Z0-9_-]+)/ and do {
yading@10:         delete $defs{$1};
yading@10:         next;
yading@10:     };
yading@10: 
yading@10:     next unless $output;
yading@10: 
yading@10:     # Discard comments.  (Can't do it above, because then we'd never see
yading@10:     # @c man lines.)
yading@10:     /^\@c\b/ and next;
yading@10: 
yading@10:     # End-block handler goes up here because it needs to operate even
yading@10:     # if we are skipping.
yading@10:     /^\@end\s+([a-z]+)/ and do {
yading@10:         # Ignore @end foo, where foo is not an operation which may
yading@10:         # cause us to skip, if we are presently skipping.
yading@10:         my $ended = $1;
yading@10:         next if $skipping && $ended !~ /^(?:ifset|ifclear|ignore|menu|iftex|ifhtml|ifnothtml)$/;
yading@10: 
yading@10:         die "\@end $ended without \@$ended at line $.\n" unless defined $endw;
yading@10:         die "\@$endw ended by \@end $ended at line $.\n" unless $ended eq $endw;
yading@10: 
yading@10:         $endw = pop @endwstack;
yading@10: 
yading@10:         if ($ended =~ /^(?:ifset|ifclear|ignore|menu|iftex|ifhtml|ifnothtml)$/) {
yading@10:             $skipping = pop @skstack;
yading@10:             next;
yading@10:         } elsif ($ended =~ /^(?:example|smallexample|display)$/) {
yading@10:             $shift = "";
yading@10:             $_ = "";        # need a paragraph break
yading@10:         } elsif ($ended =~ /^(?:itemize|enumerate|(?:multi|[fv])?table)$/) {
yading@10:             $_ = "\n=back\n";
yading@10:             $ic = pop @icstack;
yading@10:         } else {
yading@10:             die "unknown command \@end $ended at line $.\n";
yading@10:         }
yading@10:     };
yading@10: 
yading@10:     # We must handle commands which can cause skipping even while we
yading@10:     # are skipping, otherwise we will not process nested conditionals
yading@10:     # correctly.
yading@10:     /^\@ifset\s+([a-zA-Z0-9_-]+)/ and do {
yading@10:         push @endwstack, $endw;
yading@10:         push @skstack, $skipping;
yading@10:         $endw = "ifset";
yading@10:         $skipping = 1 unless exists $defs{$1};
yading@10:         next;
yading@10:     };
yading@10: 
yading@10:     /^\@ifclear\s+([a-zA-Z0-9_-]+)/ and do {
yading@10:         push @endwstack, $endw;
yading@10:         push @skstack, $skipping;
yading@10:         $endw = "ifclear";
yading@10:         $skipping = 1 if exists $defs{$1};
yading@10:         next;
yading@10:     };
yading@10: 
yading@10:     /^\@(ignore|menu|iftex|ifhtml|ifnothtml)\b/ and do {
yading@10:         push @endwstack, $endw;
yading@10:         push @skstack, $skipping;
yading@10:         $endw = $1;
yading@10:         $skipping = $endw !~ /ifnothtml/;
yading@10:         next;
yading@10:     };
yading@10: 
yading@10:     next if $skipping;
yading@10: 
yading@10:     # Character entities.  First the ones that can be replaced by raw text
yading@10:     # or discarded outright:
yading@10:     s/\@copyright\{\}/(c)/g;
yading@10:     s/\@dots\{\}/.../g;
yading@10:     s/\@enddots\{\}/..../g;
yading@10:     s/\@([.!? ])/$1/g;
yading@10:     s/\@[:-]//g;
yading@10:     s/\@bullet(?:\{\})?/*/g;
yading@10:     s/\@TeX\{\}/TeX/g;
yading@10:     s/\@pounds\{\}/\#/g;
yading@10:     s/\@minus(?:\{\})?/-/g;
yading@10: 
yading@10:     # Now the ones that have to be replaced by special escapes
yading@10:     # (which will be turned back into text by unmunge())
yading@10:     s/&/&amp;/g;
yading@10:     s/\@\{/&lbrace;/g;
yading@10:     s/\@\}/&rbrace;/g;
yading@10:     s/\@\@/&at;/g;
yading@10: 
yading@10:     # Inside a verbatim block, handle @var specially.
yading@10:     if ($shift ne "") {
yading@10:         s/\@var\{([^\}]*)\}/<$1>/g;
yading@10:     }
yading@10: 
yading@10:     # POD doesn't interpret E<> inside a verbatim block.
yading@10:     if ($shift eq "") {
yading@10:         s/</&lt;/g;
yading@10:         s/>/&gt;/g;
yading@10:     } else {
yading@10:         s/</&LT;/g;
yading@10:         s/>/&GT;/g;
yading@10:     }
yading@10: 
yading@10:     # Single line command handlers.
yading@10: 
yading@10:     /^\@(?:section|unnumbered|unnumberedsec|center|heading)\s+(.+)$/
yading@10:         and $_ = "\n=head2 $1\n";
yading@10:     /^\@(?:subsection|subheading)\s+(.+)$/
yading@10:         and $_ = "\n=head3 $1\n";
yading@10:     /^\@(?:subsubsection|subsubheading)\s+(.+)$/
yading@10:         and $_ = "\n=head4 $1\n";
yading@10: 
yading@10:     # Block command handlers:
yading@10:     /^\@itemize\s*(\@[a-z]+|\*|-)?/ and do {
yading@10:         push @endwstack, $endw;
yading@10:         push @icstack, $ic;
yading@10:         $ic = $1 ? $1 : "*";
yading@10:         $_ = "\n=over 4\n";
yading@10:         $endw = "itemize";
yading@10:     };
yading@10: 
yading@10:     /^\@enumerate(?:\s+([a-zA-Z0-9]+))?/ and do {
yading@10:         push @endwstack, $endw;
yading@10:         push @icstack, $ic;
yading@10:         if (defined $1) {
yading@10:             $ic = $1 . ".";
yading@10:         } else {
yading@10:             $ic = "1.";
yading@10:         }
yading@10:         $_ = "\n=over 4\n";
yading@10:         $endw = "enumerate";
yading@10:     };
yading@10: 
yading@10:     /^\@((?:multi|[fv])?table)\s+(\@[a-z]+)/ and do {
yading@10:         push @endwstack, $endw;
yading@10:         push @icstack, $ic;
yading@10:         $endw = $1;
yading@10:         $ic = $2;
yading@10:         $ic =~ s/\@(?:samp|strong|key|gcctabopt|option|env|command)/B/;
yading@10:         $ic =~ s/\@(?:code|kbd)/C/;
yading@10:         $ic =~ s/\@(?:dfn|var|emph|cite|i)/I/;
yading@10:         $ic =~ s/\@(?:file)/F/;
yading@10:         $ic =~ s/\@(?:columnfractions)//;
yading@10:         $_ = "\n=over 4\n";
yading@10:     };
yading@10: 
yading@10:     /^\@((?:small)?example|display)/ and do {
yading@10:         push @endwstack, $endw;
yading@10:         $endw = $1;
yading@10:         $shift = "\t";
yading@10:         $_ = "";        # need a paragraph break
yading@10:     };
yading@10: 
yading@10:     /^\@item\s+(.*\S)\s*$/ and $endw eq "multitable" and do {
yading@10:         my $columns = $1;
yading@10:         $columns =~ s/\@tab/ : /;
yading@10: 
yading@10:         $_ = "\n=item B&LT;". $columns ."&GT;\n";
yading@10:     };
yading@10: 
yading@10:     /^\@tab\s+(.*\S)\s*$/ and $endw eq "multitable" and do {
yading@10:         my $columns = $1;
yading@10:         $columns =~ s/\@tab/ : /;
yading@10: 
yading@10:         $_ = " : ". $columns;
yading@10:         $chapter =~ s/\n+\s+$//;
yading@10:     };
yading@10: 
yading@10:     /^\@itemx?\s*(.+)?$/ and do {
yading@10:         if (defined $1) {
yading@10:             # Entity escapes prevent munging by the <> processing below.
yading@10:             $_ = "\n=item $ic\&LT;$1\&GT;\n";
yading@10:         } else {
yading@10:             $_ = "\n=item $ic\n";
yading@10:             $ic =~ y/A-Ya-y/B-Zb-z/;
yading@10:             $ic =~ s/(\d+)/$1 + 1/eg;
yading@10:         }
yading@10:     };
yading@10: 
yading@10:     $chapter .= $shift.$_."\n";
yading@10: }
yading@10: # End of current file.
yading@10: close($inf);
yading@10: $inf = pop @instack;
yading@10: }
yading@10: 
yading@10: die "No filename or title\n" unless defined $fn && defined $tl;
yading@10: 
yading@10: $chapters{NAME} = "$fn \- $tl\n";
yading@10: $chapters{FOOTNOTES} .= "=back\n" if exists $chapters{FOOTNOTES};
yading@10: 
yading@10: unshift @chapters_sequence, "NAME";
yading@10: for $chapter (@chapters_sequence) {
yading@10:     if (exists $chapters{$chapter}) {
yading@10:         $head = uc($chapter);
yading@10:         print "=head1 $head\n\n";
yading@10:         print scalar unmunge ($chapters{$chapter});
yading@10:         print "\n";
yading@10:     }
yading@10: }
yading@10: 
yading@10: sub usage
yading@10: {
yading@10:     die "usage: $0 [-D toggle...] [infile [outfile]]\n";
yading@10: }
yading@10: 
yading@10: sub postprocess
yading@10: {
yading@10:     local $_ = $_[0];
yading@10: 
yading@10:     # @value{foo} is replaced by whatever 'foo' is defined as.
yading@10:     while (m/(\@value\{([a-zA-Z0-9_-]+)\})/g) {
yading@10:         if (! exists $defs{$2}) {
yading@10:             print STDERR "Option $2 not defined\n";
yading@10:             s/\Q$1\E//;
yading@10:         } else {
yading@10:             $value = $defs{$2};
yading@10:             s/\Q$1\E/$value/;
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     # Formatting commands.
yading@10:     # Temporary escape for @r.
yading@10:     s/\@r\{([^\}]*)\}/R<$1>/g;
yading@10:     s/\@(?:dfn|var|emph|cite|i)\{([^\}]*)\}/I<$1>/g;
yading@10:     s/\@(?:code|kbd)\{([^\}]*)\}/C<$1>/g;
yading@10:     s/\@(?:gccoptlist|samp|strong|key|option|env|command|b)\{([^\}]*)\}/B<$1>/g;
yading@10:     s/\@sc\{([^\}]*)\}/\U$1/g;
yading@10:     s/\@file\{([^\}]*)\}/F<$1>/g;
yading@10:     s/\@w\{([^\}]*)\}/S<$1>/g;
yading@10:     s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;
yading@10: 
yading@10:     # Cross references are thrown away, as are @noindent and @refill.
yading@10:     # (@noindent is impossible in .pod, and @refill is unnecessary.)
yading@10:     # @* is also impossible in .pod; we discard it and any newline that
yading@10:     # follows it.  Similarly, our macro @gol must be discarded.
yading@10: 
yading@10:     s/\@anchor{(?:[^\}]*)\}//g;
yading@10:     s/\(?\@xref\{(?:[^\}]*)\}(?:[^.<]|(?:<[^<>]*>))*\.\)?//g;
yading@10:     s/\s+\(\@pxref\{(?:[^\}]*)\}\)//g;
yading@10:     s/;\s+\@pxref\{(?:[^\}]*)\}//g;
yading@10:     s/\@ref\{(?:[^,\}]*,)(?:[^,\}]*,)([^,\}]*).*\}/$1/g;
yading@10:     s/\@ref\{([^\}]*)\}/$1/g;
yading@10:     s/\@noindent\s*//g;
yading@10:     s/\@refill//g;
yading@10:     s/\@gol//g;
yading@10:     s/\@\*\s*\n?//g;
yading@10: 
yading@10:     # @uref can take one, two, or three arguments, with different
yading@10:     # semantics each time.  @url and @email are just like @uref with
yading@10:     # one argument, for our purposes.
yading@10:     s/\@(?:uref|url|email)\{([^\},]*),?[^\}]*\}/&lt;B<$1>&gt;/g;
yading@10:     s/\@uref\{([^\},]*),([^\},]*)\}/$2 (C<$1>)/g;
yading@10:     s/\@uref\{([^\},]*),([^\},]*),([^\},]*)\}/$3/g;
yading@10: 
yading@10:     # Turn B<blah I<blah> blah> into B<blah> I<blah> B<blah> to
yading@10:     # match Texinfo semantics of @emph inside @samp.  Also handle @r
yading@10:     # inside bold.
yading@10:     s/&LT;/</g;
yading@10:     s/&GT;/>/g;
yading@10:     1 while s/B<((?:[^<>]|I<[^<>]*>)*)R<([^>]*)>/B<$1>${2}B</g;
yading@10:     1 while (s/B<([^<>]*)I<([^>]+)>/B<$1>I<$2>B</g);
yading@10:     1 while (s/I<([^<>]*)B<([^>]+)>/I<$1>B<$2>I</g);
yading@10:     s/[BI]<>//g;
yading@10:     s/([BI])<(\s+)([^>]+)>/$2$1<$3>/g;
yading@10:     s/([BI])<([^>]+?)(\s+)>/$1<$2>$3/g;
yading@10: 
yading@10:     # Extract footnotes.  This has to be done after all other
yading@10:     # processing because otherwise the regexp will choke on formatting
yading@10:     # inside @footnote.
yading@10:     while (/\@footnote/g) {
yading@10:         s/\@footnote\{([^\}]+)\}/[$fnno]/;
yading@10:         add_footnote($1, $fnno);
yading@10:         $fnno++;
yading@10:     }
yading@10: 
yading@10:     return $_;
yading@10: }
yading@10: 
yading@10: sub unmunge
yading@10: {
yading@10:     # Replace escaped symbols with their equivalents.
yading@10:     local $_ = $_[0];
yading@10: 
yading@10:     s/&lt;/E<lt>/g;
yading@10:     s/&gt;/E<gt>/g;
yading@10:     s/&lbrace;/\{/g;
yading@10:     s/&rbrace;/\}/g;
yading@10:     s/&at;/\@/g;
yading@10:     s/&amp;/&/g;
yading@10:     return $_;
yading@10: }
yading@10: 
yading@10: sub add_footnote
yading@10: {
yading@10:     unless (exists $chapters{FOOTNOTES}) {
yading@10:         $chapters{FOOTNOTES} = "\n=over 4\n\n";
yading@10:     }
yading@10: 
yading@10:     $chapters{FOOTNOTES} .= "=item $fnno.\n\n"; $fnno++;
yading@10:     $chapters{FOOTNOTES} .= $_[0];
yading@10:     $chapters{FOOTNOTES} .= "\n\n";
yading@10: }
yading@10: 
yading@10: # stolen from Symbol.pm
yading@10: {
yading@10:     my $genseq = 0;
yading@10:     sub gensym
yading@10:     {
yading@10:         my $name = "GEN" . $genseq++;
yading@10:         my $ref = \*{$name};
yading@10:         delete $::{$name};
yading@10:         return $ref;
yading@10:     }
yading@10: }